Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- CreateReplicationSet
- CreateResponsePlan
- CreateTimelineEvent
- DeleteIncidentRecord
- DeleteReplicationSet
- DeleteResourcePolicy
- DeleteResponsePlan
- DeleteTimelineEvent
- GetIncidentRecord
- GetReplicationSet
- GetResourcePolicies
- GetResponsePlan
- GetTimelineEvent
- ListIncidentRecords
- ListRelatedItems
- ListReplicationSets
- ListResponsePlans
- ListTagsForResource
- ListTimelineEvents
- PutResourcePolicy
- StartIncident
- TagResource
- UntagResource
- UpdateDeletionProtection
- UpdateIncidentRecord
- UpdateRelatedItems
- UpdateReplicationSet
- UpdateResponsePlan
- UpdateTimelineEvent
- Types
- Action
- AddRegionAction
- AttributeValueList
- AutomationExecution
- ChatChannel
- Condition
- DeleteRegionAction
- DynamicSsmParameterValue
- EmptyChatChannel
- EventReference
- EventSummary
- Filter
- IncidentRecord
- IncidentRecordSource
- IncidentRecordSummary
- IncidentTemplate
- Integration
- ItemIdentifier
- ItemValue
- NotificationTargetItem
- PagerDutyConfiguration
- PagerDutyIncidentConfiguration
- PagerDutyIncidentDetail
- RegionInfo
- RegionMapInputValue
- RelatedItem
- RelatedItemsUpdate
- ReplicationSet
- ResourcePolicy
- ResponsePlanSummary
- SsmAutomation
- TimelineEvent
- TriggerDetails
- UpdateReplicationSetAction
Synopsis
- createReplicationSet_clientToken :: Lens' CreateReplicationSet (Maybe Text)
- createReplicationSet_tags :: Lens' CreateReplicationSet (Maybe (HashMap Text Text))
- createReplicationSet_regions :: Lens' CreateReplicationSet (HashMap Text RegionMapInputValue)
- createReplicationSetResponse_httpStatus :: Lens' CreateReplicationSetResponse Int
- createReplicationSetResponse_arn :: Lens' CreateReplicationSetResponse Text
- createResponsePlan_actions :: Lens' CreateResponsePlan (Maybe [Action])
- createResponsePlan_chatChannel :: Lens' CreateResponsePlan (Maybe ChatChannel)
- createResponsePlan_clientToken :: Lens' CreateResponsePlan (Maybe Text)
- createResponsePlan_displayName :: Lens' CreateResponsePlan (Maybe Text)
- createResponsePlan_engagements :: Lens' CreateResponsePlan (Maybe [Text])
- createResponsePlan_integrations :: Lens' CreateResponsePlan (Maybe [Integration])
- createResponsePlan_tags :: Lens' CreateResponsePlan (Maybe (HashMap Text Text))
- createResponsePlan_incidentTemplate :: Lens' CreateResponsePlan IncidentTemplate
- createResponsePlan_name :: Lens' CreateResponsePlan Text
- createResponsePlanResponse_httpStatus :: Lens' CreateResponsePlanResponse Int
- createResponsePlanResponse_arn :: Lens' CreateResponsePlanResponse Text
- createTimelineEvent_clientToken :: Lens' CreateTimelineEvent (Maybe Text)
- createTimelineEvent_eventReferences :: Lens' CreateTimelineEvent (Maybe [EventReference])
- createTimelineEvent_eventData :: Lens' CreateTimelineEvent Text
- createTimelineEvent_eventTime :: Lens' CreateTimelineEvent UTCTime
- createTimelineEvent_eventType :: Lens' CreateTimelineEvent Text
- createTimelineEvent_incidentRecordArn :: Lens' CreateTimelineEvent Text
- createTimelineEventResponse_httpStatus :: Lens' CreateTimelineEventResponse Int
- createTimelineEventResponse_eventId :: Lens' CreateTimelineEventResponse Text
- createTimelineEventResponse_incidentRecordArn :: Lens' CreateTimelineEventResponse Text
- deleteIncidentRecord_arn :: Lens' DeleteIncidentRecord Text
- deleteIncidentRecordResponse_httpStatus :: Lens' DeleteIncidentRecordResponse Int
- deleteReplicationSet_arn :: Lens' DeleteReplicationSet Text
- deleteReplicationSetResponse_httpStatus :: Lens' DeleteReplicationSetResponse Int
- deleteResourcePolicy_policyId :: Lens' DeleteResourcePolicy Text
- deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text
- deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int
- deleteResponsePlan_arn :: Lens' DeleteResponsePlan Text
- deleteResponsePlanResponse_httpStatus :: Lens' DeleteResponsePlanResponse Int
- deleteTimelineEvent_eventId :: Lens' DeleteTimelineEvent Text
- deleteTimelineEvent_incidentRecordArn :: Lens' DeleteTimelineEvent Text
- deleteTimelineEventResponse_httpStatus :: Lens' DeleteTimelineEventResponse Int
- getIncidentRecord_arn :: Lens' GetIncidentRecord Text
- getIncidentRecordResponse_httpStatus :: Lens' GetIncidentRecordResponse Int
- getIncidentRecordResponse_incidentRecord :: Lens' GetIncidentRecordResponse IncidentRecord
- getReplicationSet_arn :: Lens' GetReplicationSet Text
- getReplicationSetResponse_httpStatus :: Lens' GetReplicationSetResponse Int
- getReplicationSetResponse_replicationSet :: Lens' GetReplicationSetResponse ReplicationSet
- getResourcePolicies_maxResults :: Lens' GetResourcePolicies (Maybe Natural)
- getResourcePolicies_nextToken :: Lens' GetResourcePolicies (Maybe Text)
- getResourcePolicies_resourceArn :: Lens' GetResourcePolicies Text
- getResourcePoliciesResponse_nextToken :: Lens' GetResourcePoliciesResponse (Maybe Text)
- getResourcePoliciesResponse_httpStatus :: Lens' GetResourcePoliciesResponse Int
- getResourcePoliciesResponse_resourcePolicies :: Lens' GetResourcePoliciesResponse [ResourcePolicy]
- getResponsePlan_arn :: Lens' GetResponsePlan Text
- getResponsePlanResponse_actions :: Lens' GetResponsePlanResponse (Maybe [Action])
- getResponsePlanResponse_chatChannel :: Lens' GetResponsePlanResponse (Maybe ChatChannel)
- getResponsePlanResponse_displayName :: Lens' GetResponsePlanResponse (Maybe Text)
- getResponsePlanResponse_engagements :: Lens' GetResponsePlanResponse (Maybe [Text])
- getResponsePlanResponse_integrations :: Lens' GetResponsePlanResponse (Maybe [Integration])
- getResponsePlanResponse_httpStatus :: Lens' GetResponsePlanResponse Int
- getResponsePlanResponse_arn :: Lens' GetResponsePlanResponse Text
- getResponsePlanResponse_incidentTemplate :: Lens' GetResponsePlanResponse IncidentTemplate
- getResponsePlanResponse_name :: Lens' GetResponsePlanResponse Text
- getTimelineEvent_eventId :: Lens' GetTimelineEvent Text
- getTimelineEvent_incidentRecordArn :: Lens' GetTimelineEvent Text
- getTimelineEventResponse_httpStatus :: Lens' GetTimelineEventResponse Int
- getTimelineEventResponse_event :: Lens' GetTimelineEventResponse TimelineEvent
- listIncidentRecords_filters :: Lens' ListIncidentRecords (Maybe [Filter])
- listIncidentRecords_maxResults :: Lens' ListIncidentRecords (Maybe Natural)
- listIncidentRecords_nextToken :: Lens' ListIncidentRecords (Maybe Text)
- listIncidentRecordsResponse_nextToken :: Lens' ListIncidentRecordsResponse (Maybe Text)
- listIncidentRecordsResponse_httpStatus :: Lens' ListIncidentRecordsResponse Int
- listIncidentRecordsResponse_incidentRecordSummaries :: Lens' ListIncidentRecordsResponse [IncidentRecordSummary]
- listRelatedItems_maxResults :: Lens' ListRelatedItems (Maybe Natural)
- listRelatedItems_nextToken :: Lens' ListRelatedItems (Maybe Text)
- listRelatedItems_incidentRecordArn :: Lens' ListRelatedItems Text
- listRelatedItemsResponse_nextToken :: Lens' ListRelatedItemsResponse (Maybe Text)
- listRelatedItemsResponse_httpStatus :: Lens' ListRelatedItemsResponse Int
- listRelatedItemsResponse_relatedItems :: Lens' ListRelatedItemsResponse [RelatedItem]
- listReplicationSets_maxResults :: Lens' ListReplicationSets (Maybe Natural)
- listReplicationSets_nextToken :: Lens' ListReplicationSets (Maybe Text)
- listReplicationSetsResponse_nextToken :: Lens' ListReplicationSetsResponse (Maybe Text)
- listReplicationSetsResponse_httpStatus :: Lens' ListReplicationSetsResponse Int
- listReplicationSetsResponse_replicationSetArns :: Lens' ListReplicationSetsResponse [Text]
- listResponsePlans_maxResults :: Lens' ListResponsePlans (Maybe Natural)
- listResponsePlans_nextToken :: Lens' ListResponsePlans (Maybe Text)
- listResponsePlansResponse_nextToken :: Lens' ListResponsePlansResponse (Maybe Text)
- listResponsePlansResponse_httpStatus :: Lens' ListResponsePlansResponse Int
- listResponsePlansResponse_responsePlanSummaries :: Lens' ListResponsePlansResponse [ResponsePlanSummary]
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (HashMap Text Text)
- listTimelineEvents_filters :: Lens' ListTimelineEvents (Maybe [Filter])
- listTimelineEvents_maxResults :: Lens' ListTimelineEvents (Maybe Natural)
- listTimelineEvents_nextToken :: Lens' ListTimelineEvents (Maybe Text)
- listTimelineEvents_sortBy :: Lens' ListTimelineEvents (Maybe TimelineEventSort)
- listTimelineEvents_sortOrder :: Lens' ListTimelineEvents (Maybe SortOrder)
- listTimelineEvents_incidentRecordArn :: Lens' ListTimelineEvents Text
- listTimelineEventsResponse_nextToken :: Lens' ListTimelineEventsResponse (Maybe Text)
- listTimelineEventsResponse_httpStatus :: Lens' ListTimelineEventsResponse Int
- listTimelineEventsResponse_eventSummaries :: Lens' ListTimelineEventsResponse [EventSummary]
- putResourcePolicy_policy :: Lens' PutResourcePolicy Text
- putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text
- putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int
- putResourcePolicyResponse_policyId :: Lens' PutResourcePolicyResponse Text
- startIncident_clientToken :: Lens' StartIncident (Maybe Text)
- startIncident_impact :: Lens' StartIncident (Maybe Natural)
- startIncident_relatedItems :: Lens' StartIncident (Maybe [RelatedItem])
- startIncident_title :: Lens' StartIncident (Maybe Text)
- startIncident_triggerDetails :: Lens' StartIncident (Maybe TriggerDetails)
- startIncident_responsePlanArn :: Lens' StartIncident Text
- startIncidentResponse_httpStatus :: Lens' StartIncidentResponse Int
- startIncidentResponse_incidentRecordArn :: Lens' StartIncidentResponse Text
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateDeletionProtection_clientToken :: Lens' UpdateDeletionProtection (Maybe Text)
- updateDeletionProtection_arn :: Lens' UpdateDeletionProtection Text
- updateDeletionProtection_deletionProtected :: Lens' UpdateDeletionProtection Bool
- updateDeletionProtectionResponse_httpStatus :: Lens' UpdateDeletionProtectionResponse Int
- updateIncidentRecord_chatChannel :: Lens' UpdateIncidentRecord (Maybe ChatChannel)
- updateIncidentRecord_clientToken :: Lens' UpdateIncidentRecord (Maybe Text)
- updateIncidentRecord_impact :: Lens' UpdateIncidentRecord (Maybe Natural)
- updateIncidentRecord_notificationTargets :: Lens' UpdateIncidentRecord (Maybe [NotificationTargetItem])
- updateIncidentRecord_status :: Lens' UpdateIncidentRecord (Maybe IncidentRecordStatus)
- updateIncidentRecord_summary :: Lens' UpdateIncidentRecord (Maybe Text)
- updateIncidentRecord_title :: Lens' UpdateIncidentRecord (Maybe Text)
- updateIncidentRecord_arn :: Lens' UpdateIncidentRecord Text
- updateIncidentRecordResponse_httpStatus :: Lens' UpdateIncidentRecordResponse Int
- updateRelatedItems_clientToken :: Lens' UpdateRelatedItems (Maybe Text)
- updateRelatedItems_incidentRecordArn :: Lens' UpdateRelatedItems Text
- updateRelatedItems_relatedItemsUpdate :: Lens' UpdateRelatedItems RelatedItemsUpdate
- updateRelatedItemsResponse_httpStatus :: Lens' UpdateRelatedItemsResponse Int
- updateReplicationSet_clientToken :: Lens' UpdateReplicationSet (Maybe Text)
- updateReplicationSet_actions :: Lens' UpdateReplicationSet (NonEmpty UpdateReplicationSetAction)
- updateReplicationSet_arn :: Lens' UpdateReplicationSet Text
- updateReplicationSetResponse_httpStatus :: Lens' UpdateReplicationSetResponse Int
- updateResponsePlan_actions :: Lens' UpdateResponsePlan (Maybe [Action])
- updateResponsePlan_chatChannel :: Lens' UpdateResponsePlan (Maybe ChatChannel)
- updateResponsePlan_clientToken :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_displayName :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_engagements :: Lens' UpdateResponsePlan (Maybe [Text])
- updateResponsePlan_incidentTemplateDedupeString :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_incidentTemplateImpact :: Lens' UpdateResponsePlan (Maybe Natural)
- updateResponsePlan_incidentTemplateNotificationTargets :: Lens' UpdateResponsePlan (Maybe [NotificationTargetItem])
- updateResponsePlan_incidentTemplateSummary :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_incidentTemplateTags :: Lens' UpdateResponsePlan (Maybe (HashMap Text Text))
- updateResponsePlan_incidentTemplateTitle :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_integrations :: Lens' UpdateResponsePlan (Maybe [Integration])
- updateResponsePlan_arn :: Lens' UpdateResponsePlan Text
- updateResponsePlanResponse_httpStatus :: Lens' UpdateResponsePlanResponse Int
- updateTimelineEvent_clientToken :: Lens' UpdateTimelineEvent (Maybe Text)
- updateTimelineEvent_eventData :: Lens' UpdateTimelineEvent (Maybe Text)
- updateTimelineEvent_eventReferences :: Lens' UpdateTimelineEvent (Maybe [EventReference])
- updateTimelineEvent_eventTime :: Lens' UpdateTimelineEvent (Maybe UTCTime)
- updateTimelineEvent_eventType :: Lens' UpdateTimelineEvent (Maybe Text)
- updateTimelineEvent_eventId :: Lens' UpdateTimelineEvent Text
- updateTimelineEvent_incidentRecordArn :: Lens' UpdateTimelineEvent Text
- updateTimelineEventResponse_httpStatus :: Lens' UpdateTimelineEventResponse Int
- action_ssmAutomation :: Lens' Action (Maybe SsmAutomation)
- addRegionAction_sseKmsKeyId :: Lens' AddRegionAction (Maybe Text)
- addRegionAction_regionName :: Lens' AddRegionAction Text
- attributeValueList_integerValues :: Lens' AttributeValueList (Maybe [Int])
- attributeValueList_stringValues :: Lens' AttributeValueList (Maybe [Text])
- automationExecution_ssmExecutionArn :: Lens' AutomationExecution (Maybe Text)
- chatChannel_chatbotSns :: Lens' ChatChannel (Maybe (NonEmpty Text))
- chatChannel_empty :: Lens' ChatChannel (Maybe EmptyChatChannel)
- condition_after :: Lens' Condition (Maybe UTCTime)
- condition_before :: Lens' Condition (Maybe UTCTime)
- condition_equals :: Lens' Condition (Maybe AttributeValueList)
- deleteRegionAction_regionName :: Lens' DeleteRegionAction Text
- dynamicSsmParameterValue_variable :: Lens' DynamicSsmParameterValue (Maybe VariableType)
- eventReference_relatedItemId :: Lens' EventReference (Maybe Text)
- eventReference_resource :: Lens' EventReference (Maybe Text)
- eventSummary_eventReferences :: Lens' EventSummary (Maybe [EventReference])
- eventSummary_eventId :: Lens' EventSummary Text
- eventSummary_eventTime :: Lens' EventSummary UTCTime
- eventSummary_eventType :: Lens' EventSummary Text
- eventSummary_eventUpdatedTime :: Lens' EventSummary UTCTime
- eventSummary_incidentRecordArn :: Lens' EventSummary Text
- filter_condition :: Lens' Filter Condition
- filter_key :: Lens' Filter Text
- incidentRecord_automationExecutions :: Lens' IncidentRecord (Maybe [AutomationExecution])
- incidentRecord_chatChannel :: Lens' IncidentRecord (Maybe ChatChannel)
- incidentRecord_notificationTargets :: Lens' IncidentRecord (Maybe [NotificationTargetItem])
- incidentRecord_resolvedTime :: Lens' IncidentRecord (Maybe UTCTime)
- incidentRecord_summary :: Lens' IncidentRecord (Maybe Text)
- incidentRecord_arn :: Lens' IncidentRecord Text
- incidentRecord_creationTime :: Lens' IncidentRecord UTCTime
- incidentRecord_dedupeString :: Lens' IncidentRecord Text
- incidentRecord_impact :: Lens' IncidentRecord Natural
- incidentRecord_incidentRecordSource :: Lens' IncidentRecord IncidentRecordSource
- incidentRecord_lastModifiedBy :: Lens' IncidentRecord Text
- incidentRecord_lastModifiedTime :: Lens' IncidentRecord UTCTime
- incidentRecord_status :: Lens' IncidentRecord IncidentRecordStatus
- incidentRecord_title :: Lens' IncidentRecord Text
- incidentRecordSource_invokedBy :: Lens' IncidentRecordSource (Maybe Text)
- incidentRecordSource_resourceArn :: Lens' IncidentRecordSource (Maybe Text)
- incidentRecordSource_createdBy :: Lens' IncidentRecordSource Text
- incidentRecordSource_source :: Lens' IncidentRecordSource Text
- incidentRecordSummary_resolvedTime :: Lens' IncidentRecordSummary (Maybe UTCTime)
- incidentRecordSummary_arn :: Lens' IncidentRecordSummary Text
- incidentRecordSummary_creationTime :: Lens' IncidentRecordSummary UTCTime
- incidentRecordSummary_impact :: Lens' IncidentRecordSummary Natural
- incidentRecordSummary_incidentRecordSource :: Lens' IncidentRecordSummary IncidentRecordSource
- incidentRecordSummary_status :: Lens' IncidentRecordSummary IncidentRecordStatus
- incidentRecordSummary_title :: Lens' IncidentRecordSummary Text
- incidentTemplate_dedupeString :: Lens' IncidentTemplate (Maybe Text)
- incidentTemplate_incidentTags :: Lens' IncidentTemplate (Maybe (HashMap Text Text))
- incidentTemplate_notificationTargets :: Lens' IncidentTemplate (Maybe [NotificationTargetItem])
- incidentTemplate_summary :: Lens' IncidentTemplate (Maybe Text)
- incidentTemplate_impact :: Lens' IncidentTemplate Natural
- incidentTemplate_title :: Lens' IncidentTemplate Text
- integration_pagerDutyConfiguration :: Lens' Integration (Maybe PagerDutyConfiguration)
- itemIdentifier_type :: Lens' ItemIdentifier ItemType
- itemIdentifier_value :: Lens' ItemIdentifier ItemValue
- itemValue_arn :: Lens' ItemValue (Maybe Text)
- itemValue_metricDefinition :: Lens' ItemValue (Maybe Text)
- itemValue_pagerDutyIncidentDetail :: Lens' ItemValue (Maybe PagerDutyIncidentDetail)
- itemValue_url :: Lens' ItemValue (Maybe Text)
- notificationTargetItem_snsTopicArn :: Lens' NotificationTargetItem (Maybe Text)
- pagerDutyConfiguration_name :: Lens' PagerDutyConfiguration Text
- pagerDutyConfiguration_pagerDutyIncidentConfiguration :: Lens' PagerDutyConfiguration PagerDutyIncidentConfiguration
- pagerDutyConfiguration_secretId :: Lens' PagerDutyConfiguration Text
- pagerDutyIncidentConfiguration_serviceId :: Lens' PagerDutyIncidentConfiguration Text
- pagerDutyIncidentDetail_autoResolve :: Lens' PagerDutyIncidentDetail (Maybe Bool)
- pagerDutyIncidentDetail_secretId :: Lens' PagerDutyIncidentDetail (Maybe Text)
- pagerDutyIncidentDetail_id :: Lens' PagerDutyIncidentDetail Text
- regionInfo_sseKmsKeyId :: Lens' RegionInfo (Maybe Text)
- regionInfo_statusMessage :: Lens' RegionInfo (Maybe Text)
- regionInfo_status :: Lens' RegionInfo RegionStatus
- regionInfo_statusUpdateDateTime :: Lens' RegionInfo UTCTime
- regionMapInputValue_sseKmsKeyId :: Lens' RegionMapInputValue (Maybe Text)
- relatedItem_generatedId :: Lens' RelatedItem (Maybe Text)
- relatedItem_title :: Lens' RelatedItem (Maybe Text)
- relatedItem_identifier :: Lens' RelatedItem ItemIdentifier
- relatedItemsUpdate_itemToAdd :: Lens' RelatedItemsUpdate (Maybe RelatedItem)
- relatedItemsUpdate_itemToRemove :: Lens' RelatedItemsUpdate (Maybe ItemIdentifier)
- replicationSet_arn :: Lens' ReplicationSet (Maybe Text)
- replicationSet_createdBy :: Lens' ReplicationSet Text
- replicationSet_createdTime :: Lens' ReplicationSet UTCTime
- replicationSet_deletionProtected :: Lens' ReplicationSet Bool
- replicationSet_lastModifiedBy :: Lens' ReplicationSet Text
- replicationSet_lastModifiedTime :: Lens' ReplicationSet UTCTime
- replicationSet_regionMap :: Lens' ReplicationSet (HashMap Text RegionInfo)
- replicationSet_status :: Lens' ReplicationSet ReplicationSetStatus
- resourcePolicy_policyDocument :: Lens' ResourcePolicy Text
- resourcePolicy_policyId :: Lens' ResourcePolicy Text
- resourcePolicy_ramResourceShareRegion :: Lens' ResourcePolicy Text
- responsePlanSummary_displayName :: Lens' ResponsePlanSummary (Maybe Text)
- responsePlanSummary_arn :: Lens' ResponsePlanSummary Text
- responsePlanSummary_name :: Lens' ResponsePlanSummary Text
- ssmAutomation_documentVersion :: Lens' SsmAutomation (Maybe Text)
- ssmAutomation_dynamicParameters :: Lens' SsmAutomation (Maybe (HashMap Text DynamicSsmParameterValue))
- ssmAutomation_parameters :: Lens' SsmAutomation (Maybe (HashMap Text [Text]))
- ssmAutomation_targetAccount :: Lens' SsmAutomation (Maybe SsmTargetAccount)
- ssmAutomation_documentName :: Lens' SsmAutomation Text
- ssmAutomation_roleArn :: Lens' SsmAutomation Text
- timelineEvent_eventReferences :: Lens' TimelineEvent (Maybe [EventReference])
- timelineEvent_eventData :: Lens' TimelineEvent Text
- timelineEvent_eventId :: Lens' TimelineEvent Text
- timelineEvent_eventTime :: Lens' TimelineEvent UTCTime
- timelineEvent_eventType :: Lens' TimelineEvent Text
- timelineEvent_eventUpdatedTime :: Lens' TimelineEvent UTCTime
- timelineEvent_incidentRecordArn :: Lens' TimelineEvent Text
- triggerDetails_rawData :: Lens' TriggerDetails (Maybe Text)
- triggerDetails_triggerArn :: Lens' TriggerDetails (Maybe Text)
- triggerDetails_source :: Lens' TriggerDetails Text
- triggerDetails_timestamp :: Lens' TriggerDetails UTCTime
- updateReplicationSetAction_addRegionAction :: Lens' UpdateReplicationSetAction (Maybe AddRegionAction)
- updateReplicationSetAction_deleteRegionAction :: Lens' UpdateReplicationSetAction (Maybe DeleteRegionAction)
Operations
CreateReplicationSet
createReplicationSet_clientToken :: Lens' CreateReplicationSet (Maybe Text) Source #
A token that ensures that the operation is called only once with the specified details.
createReplicationSet_tags :: Lens' CreateReplicationSet (Maybe (HashMap Text Text)) Source #
A list of tags to add to the replication set.
createReplicationSet_regions :: Lens' CreateReplicationSet (HashMap Text RegionMapInputValue) Source #
The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
createReplicationSetResponse_httpStatus :: Lens' CreateReplicationSetResponse Int Source #
The response's http status code.
createReplicationSetResponse_arn :: Lens' CreateReplicationSetResponse Text Source #
The Amazon Resource Name (ARN) of the replication set.
CreateResponsePlan
createResponsePlan_actions :: Lens' CreateResponsePlan (Maybe [Action]) Source #
The actions that the response plan starts at the beginning of an incident.
createResponsePlan_chatChannel :: Lens' CreateResponsePlan (Maybe ChatChannel) Source #
The Chatbot chat channel used for collaboration during an incident.
createResponsePlan_clientToken :: Lens' CreateResponsePlan (Maybe Text) Source #
A token ensuring that the operation is called only once with the specified details.
createResponsePlan_displayName :: Lens' CreateResponsePlan (Maybe Text) Source #
The long format of the response plan name. This field can contain spaces.
createResponsePlan_engagements :: Lens' CreateResponsePlan (Maybe [Text]) Source #
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
createResponsePlan_integrations :: Lens' CreateResponsePlan (Maybe [Integration]) Source #
Information about third-party services integrated into the response plan.
createResponsePlan_tags :: Lens' CreateResponsePlan (Maybe (HashMap Text Text)) Source #
A list of tags that you are adding to the response plan.
createResponsePlan_incidentTemplate :: Lens' CreateResponsePlan IncidentTemplate Source #
Details used to create an incident when using this response plan.
createResponsePlan_name :: Lens' CreateResponsePlan Text Source #
The short format name of the response plan. Can't include spaces.
createResponsePlanResponse_httpStatus :: Lens' CreateResponsePlanResponse Int Source #
The response's http status code.
createResponsePlanResponse_arn :: Lens' CreateResponsePlanResponse Text Source #
The Amazon Resource Name (ARN) of the response plan.
CreateTimelineEvent
createTimelineEvent_clientToken :: Lens' CreateTimelineEvent (Maybe Text) Source #
A token ensuring that the action is called only once with the specified details.
createTimelineEvent_eventReferences :: Lens' CreateTimelineEvent (Maybe [EventReference]) Source #
Adds one or more references to the TimelineEvent
. A reference can be
an Amazon Web Services resource involved in the incident or in some way
associated with it. When you specify a reference, you enter the Amazon
Resource Name (ARN) of the resource. You can also specify a related
item. As an example, you could specify the ARN of an Amazon DynamoDB
(DynamoDB) table. The table for this example is the resource. You could
also specify a Amazon CloudWatch metric for that table. The metric is
the related item.
createTimelineEvent_eventData :: Lens' CreateTimelineEvent Text Source #
A short description of the event.
createTimelineEvent_eventTime :: Lens' CreateTimelineEvent UTCTime Source #
The time that the event occurred.
createTimelineEvent_eventType :: Lens' CreateTimelineEvent Text Source #
The type of the event. You can create timeline events of type
Custom Event
.
createTimelineEvent_incidentRecordArn :: Lens' CreateTimelineEvent Text Source #
The Amazon Resource Name (ARN) of the incident record to which the event will be added.
createTimelineEventResponse_httpStatus :: Lens' CreateTimelineEventResponse Int Source #
The response's http status code.
createTimelineEventResponse_eventId :: Lens' CreateTimelineEventResponse Text Source #
The ID of the event for easy reference later.
createTimelineEventResponse_incidentRecordArn :: Lens' CreateTimelineEventResponse Text Source #
The ARN of the incident record that you added the event to.
DeleteIncidentRecord
deleteIncidentRecord_arn :: Lens' DeleteIncidentRecord Text Source #
The Amazon Resource Name (ARN) of the incident record you are deleting.
deleteIncidentRecordResponse_httpStatus :: Lens' DeleteIncidentRecordResponse Int Source #
The response's http status code.
DeleteReplicationSet
deleteReplicationSet_arn :: Lens' DeleteReplicationSet Text Source #
The Amazon Resource Name (ARN) of the replication set you're deleting.
deleteReplicationSetResponse_httpStatus :: Lens' DeleteReplicationSetResponse Int Source #
The response's http status code.
DeleteResourcePolicy
deleteResourcePolicy_policyId :: Lens' DeleteResourcePolicy Text Source #
The ID of the resource policy you're deleting.
deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text Source #
The Amazon Resource Name (ARN) of the resource you're deleting the policy from.
deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int Source #
The response's http status code.
DeleteResponsePlan
deleteResponsePlan_arn :: Lens' DeleteResponsePlan Text Source #
The Amazon Resource Name (ARN) of the response plan.
deleteResponsePlanResponse_httpStatus :: Lens' DeleteResponsePlanResponse Int Source #
The response's http status code.
DeleteTimelineEvent
deleteTimelineEvent_eventId :: Lens' DeleteTimelineEvent Text Source #
The ID of the event you are updating. You can find this by using
ListTimelineEvents
.
deleteTimelineEvent_incidentRecordArn :: Lens' DeleteTimelineEvent Text Source #
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
deleteTimelineEventResponse_httpStatus :: Lens' DeleteTimelineEventResponse Int Source #
The response's http status code.
GetIncidentRecord
getIncidentRecord_arn :: Lens' GetIncidentRecord Text Source #
The Amazon Resource Name (ARN) of the incident record.
getIncidentRecordResponse_httpStatus :: Lens' GetIncidentRecordResponse Int Source #
The response's http status code.
getIncidentRecordResponse_incidentRecord :: Lens' GetIncidentRecordResponse IncidentRecord Source #
Details the structure of the incident record.
GetReplicationSet
getReplicationSet_arn :: Lens' GetReplicationSet Text Source #
The Amazon Resource Name (ARN) of the replication set you want to retrieve.
getReplicationSetResponse_httpStatus :: Lens' GetReplicationSetResponse Int Source #
The response's http status code.
getReplicationSetResponse_replicationSet :: Lens' GetReplicationSetResponse ReplicationSet Source #
Details of the replication set.
GetResourcePolicies
getResourcePolicies_maxResults :: Lens' GetResourcePolicies (Maybe Natural) Source #
The maximum number of resource policies to display for each page of results.
getResourcePolicies_nextToken :: Lens' GetResourcePolicies (Maybe Text) Source #
The pagination token to continue to the next page of results.
getResourcePolicies_resourceArn :: Lens' GetResourcePolicies Text Source #
The Amazon Resource Name (ARN) of the response plan with the attached resource policy.
getResourcePoliciesResponse_nextToken :: Lens' GetResourcePoliciesResponse (Maybe Text) Source #
The pagination token to continue to the next page of results.
getResourcePoliciesResponse_httpStatus :: Lens' GetResourcePoliciesResponse Int Source #
The response's http status code.
getResourcePoliciesResponse_resourcePolicies :: Lens' GetResourcePoliciesResponse [ResourcePolicy] Source #
Details about the resource policy attached to the response plan.
GetResponsePlan
getResponsePlan_arn :: Lens' GetResponsePlan Text Source #
The Amazon Resource Name (ARN) of the response plan.
getResponsePlanResponse_actions :: Lens' GetResponsePlanResponse (Maybe [Action]) Source #
The actions that this response plan takes at the beginning of the incident.
getResponsePlanResponse_chatChannel :: Lens' GetResponsePlanResponse (Maybe ChatChannel) Source #
The Chatbot chat channel used for collaboration during an incident.
getResponsePlanResponse_displayName :: Lens' GetResponsePlanResponse (Maybe Text) Source #
The long format name of the response plan. Can contain spaces.
getResponsePlanResponse_engagements :: Lens' GetResponsePlanResponse (Maybe [Text]) Source #
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
getResponsePlanResponse_integrations :: Lens' GetResponsePlanResponse (Maybe [Integration]) Source #
Information about third-party services integrated into the Incident Manager response plan.
getResponsePlanResponse_httpStatus :: Lens' GetResponsePlanResponse Int Source #
The response's http status code.
getResponsePlanResponse_arn :: Lens' GetResponsePlanResponse Text Source #
The ARN of the response plan.
getResponsePlanResponse_incidentTemplate :: Lens' GetResponsePlanResponse IncidentTemplate Source #
Details used to create the incident when using this response plan.
getResponsePlanResponse_name :: Lens' GetResponsePlanResponse Text Source #
The short format name of the response plan. The name can't contain spaces.
GetTimelineEvent
getTimelineEvent_eventId :: Lens' GetTimelineEvent Text Source #
The ID of the event. You can get an event's ID when you create it, or
by using ListTimelineEvents
.
getTimelineEvent_incidentRecordArn :: Lens' GetTimelineEvent Text Source #
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
getTimelineEventResponse_httpStatus :: Lens' GetTimelineEventResponse Int Source #
The response's http status code.
getTimelineEventResponse_event :: Lens' GetTimelineEventResponse TimelineEvent Source #
Details about the timeline event.
ListIncidentRecords
listIncidentRecords_filters :: Lens' ListIncidentRecords (Maybe [Filter]) Source #
Filters the list of incident records through which you are searching. You can filter on the following keys:
creationTime
impact
status
createdBy
Note the following when deciding how to use Filters:
- If you don't specify a Filter, the response includes all incident records.
- If you specify more than one filter in a single request, the response returns incident records that match all filters.
- If you specify a filter with more than one value, the response returns incident records that match any of the values provided.
listIncidentRecords_maxResults :: Lens' ListIncidentRecords (Maybe Natural) Source #
The maximum number of results per page.
listIncidentRecords_nextToken :: Lens' ListIncidentRecords (Maybe Text) Source #
The pagination token to continue to the next page of results.
listIncidentRecordsResponse_nextToken :: Lens' ListIncidentRecordsResponse (Maybe Text) Source #
The pagination token to continue to the next page of results.
listIncidentRecordsResponse_httpStatus :: Lens' ListIncidentRecordsResponse Int Source #
The response's http status code.
listIncidentRecordsResponse_incidentRecordSummaries :: Lens' ListIncidentRecordsResponse [IncidentRecordSummary] Source #
The details of each listed incident record.
ListRelatedItems
listRelatedItems_maxResults :: Lens' ListRelatedItems (Maybe Natural) Source #
The maximum number of related items per page.
listRelatedItems_nextToken :: Lens' ListRelatedItems (Maybe Text) Source #
The pagination token to continue to the next page of results.
listRelatedItems_incidentRecordArn :: Lens' ListRelatedItems Text Source #
The Amazon Resource Name (ARN) of the incident record containing the listed related items.
listRelatedItemsResponse_nextToken :: Lens' ListRelatedItemsResponse (Maybe Text) Source #
The pagination token to continue to the next page of results.
listRelatedItemsResponse_httpStatus :: Lens' ListRelatedItemsResponse Int Source #
The response's http status code.
listRelatedItemsResponse_relatedItems :: Lens' ListRelatedItemsResponse [RelatedItem] Source #
Details about each related item.
ListReplicationSets
listReplicationSets_maxResults :: Lens' ListReplicationSets (Maybe Natural) Source #
The maximum number of results per page.
listReplicationSets_nextToken :: Lens' ListReplicationSets (Maybe Text) Source #
The pagination token to continue to the next page of results.
listReplicationSetsResponse_nextToken :: Lens' ListReplicationSetsResponse (Maybe Text) Source #
The pagination token to continue to the next page of results.
listReplicationSetsResponse_httpStatus :: Lens' ListReplicationSetsResponse Int Source #
The response's http status code.
listReplicationSetsResponse_replicationSetArns :: Lens' ListReplicationSetsResponse [Text] Source #
The Amazon Resource Name (ARN) of the list replication set.
ListResponsePlans
listResponsePlans_maxResults :: Lens' ListResponsePlans (Maybe Natural) Source #
The maximum number of response plans per page.
listResponsePlans_nextToken :: Lens' ListResponsePlans (Maybe Text) Source #
The pagination token to continue to the next page of results.
listResponsePlansResponse_nextToken :: Lens' ListResponsePlansResponse (Maybe Text) Source #
The pagination token to continue to the next page of results.
listResponsePlansResponse_httpStatus :: Lens' ListResponsePlansResponse Int Source #
The response's http status code.
listResponsePlansResponse_responsePlanSummaries :: Lens' ListResponsePlansResponse [ResponsePlanSummary] Source #
Details of each response plan.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the response plan.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (HashMap Text Text) Source #
A list of tags for the response plan.
ListTimelineEvents
listTimelineEvents_filters :: Lens' ListTimelineEvents (Maybe [Filter]) Source #
Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:
eventTime
eventType
Note the following when deciding how to use Filters:
- If you don't specify a Filter, the response includes all timeline events.
- If you specify more than one filter in a single request, the response returns timeline events that match all filters.
- If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
listTimelineEvents_maxResults :: Lens' ListTimelineEvents (Maybe Natural) Source #
The maximum number of results per page.
listTimelineEvents_nextToken :: Lens' ListTimelineEvents (Maybe Text) Source #
The pagination token to continue to the next page of results.
listTimelineEvents_sortBy :: Lens' ListTimelineEvents (Maybe TimelineEventSort) Source #
Sort by the specified key value pair.
listTimelineEvents_sortOrder :: Lens' ListTimelineEvents (Maybe SortOrder) Source #
Sorts the order of timeline events by the value specified in the
sortBy
field.
listTimelineEvents_incidentRecordArn :: Lens' ListTimelineEvents Text Source #
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
listTimelineEventsResponse_nextToken :: Lens' ListTimelineEventsResponse (Maybe Text) Source #
The pagination token to continue to the next page of results.
listTimelineEventsResponse_httpStatus :: Lens' ListTimelineEventsResponse Int Source #
The response's http status code.
listTimelineEventsResponse_eventSummaries :: Lens' ListTimelineEventsResponse [EventSummary] Source #
Details about each event that occurred during the incident.
PutResourcePolicy
putResourcePolicy_policy :: Lens' PutResourcePolicy Text Source #
Details of the resource policy.
putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text Source #
The Amazon Resource Name (ARN) of the response plan to add the resource policy to.
putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int Source #
The response's http status code.
putResourcePolicyResponse_policyId :: Lens' PutResourcePolicyResponse Text Source #
The ID of the resource policy.
StartIncident
startIncident_clientToken :: Lens' StartIncident (Maybe Text) Source #
A token ensuring that the operation is called only once with the specified details.
startIncident_impact :: Lens' StartIncident (Maybe Natural) Source #
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Possible impacts:
1
- Critical impact, this typically relates to full application failure that impacts many to all customers.2
- High impact, partial application failure with impact to many customers.3
- Medium impact, the application is providing reduced service to customers.4
- Low impact, customer might aren't impacted by the problem yet.5
- No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
startIncident_relatedItems :: Lens' StartIncident (Maybe [RelatedItem]) Source #
Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an Amazon S3 bucket.
startIncident_title :: Lens' StartIncident (Maybe Text) Source #
Provide a title for the incident. Providing a title overwrites the title provided by the response plan.
startIncident_triggerDetails :: Lens' StartIncident (Maybe TriggerDetails) Source #
Details of what created the incident record in Incident Manager.
startIncident_responsePlanArn :: Lens' StartIncident Text Source #
The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.
startIncidentResponse_httpStatus :: Lens' StartIncidentResponse Int Source #
The response's http status code.
startIncidentResponse_incidentRecordArn :: Lens' StartIncidentResponse Text Source #
The ARN of the newly created incident record.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the response plan you're adding the tags to.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
A list of tags to add to the response plan.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the response plan you're removing a tag from.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The name of the tag to remove from the response plan.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateDeletionProtection
updateDeletionProtection_clientToken :: Lens' UpdateDeletionProtection (Maybe Text) Source #
A token that ensures that the operation is called only once with the specified details.
updateDeletionProtection_arn :: Lens' UpdateDeletionProtection Text Source #
The Amazon Resource Name (ARN) of the replication set to update.
updateDeletionProtection_deletionProtected :: Lens' UpdateDeletionProtection Bool Source #
Specifies if deletion protection is turned on or off in your account.
updateDeletionProtectionResponse_httpStatus :: Lens' UpdateDeletionProtectionResponse Int Source #
The response's http status code.
UpdateIncidentRecord
updateIncidentRecord_chatChannel :: Lens' UpdateIncidentRecord (Maybe ChatChannel) Source #
The Chatbot chat channel where responders can collaborate.
updateIncidentRecord_clientToken :: Lens' UpdateIncidentRecord (Maybe Text) Source #
A token that ensures that the operation is called only once with the specified details.
updateIncidentRecord_impact :: Lens' UpdateIncidentRecord (Maybe Natural) Source #
Defines the impact of the incident to customers and applications. Providing an impact overwrites the impact provided by the response plan.
Possible impacts:
1
- Critical impact, full application failure that impacts many to all customers.2
- High impact, partial application failure with impact to many customers.3
- Medium impact, the application is providing reduced service to customers.4
- Low impact, customer aren't impacted by the problem yet.5
- No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
updateIncidentRecord_notificationTargets :: Lens' UpdateIncidentRecord (Maybe [NotificationTargetItem]) Source #
The Amazon SNS targets that are notified when updates are made to an incident.
Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.
updateIncidentRecord_status :: Lens' UpdateIncidentRecord (Maybe IncidentRecordStatus) Source #
The status of the incident. An incident can be Open
or Resolved
.
updateIncidentRecord_summary :: Lens' UpdateIncidentRecord (Maybe Text) Source #
A longer description of what occurred during the incident.
updateIncidentRecord_title :: Lens' UpdateIncidentRecord (Maybe Text) Source #
A brief description of the incident.
updateIncidentRecord_arn :: Lens' UpdateIncidentRecord Text Source #
The Amazon Resource Name (ARN) of the incident record you are updating.
updateIncidentRecordResponse_httpStatus :: Lens' UpdateIncidentRecordResponse Int Source #
The response's http status code.
UpdateRelatedItems
updateRelatedItems_clientToken :: Lens' UpdateRelatedItems (Maybe Text) Source #
A token ensuring that the operation is called only once with the specified details.
updateRelatedItems_incidentRecordArn :: Lens' UpdateRelatedItems Text Source #
The Amazon Resource Name (ARN) of the incident record containing the related items you are updating.
updateRelatedItems_relatedItemsUpdate :: Lens' UpdateRelatedItems RelatedItemsUpdate Source #
Details about the item you are adding or deleting.
updateRelatedItemsResponse_httpStatus :: Lens' UpdateRelatedItemsResponse Int Source #
The response's http status code.
UpdateReplicationSet
updateReplicationSet_clientToken :: Lens' UpdateReplicationSet (Maybe Text) Source #
A token that ensures that the operation is called only once with the specified details.
updateReplicationSet_actions :: Lens' UpdateReplicationSet (NonEmpty UpdateReplicationSetAction) Source #
An action to add or delete a Region.
updateReplicationSet_arn :: Lens' UpdateReplicationSet Text Source #
The Amazon Resource Name (ARN) of the replication set you're updating.
updateReplicationSetResponse_httpStatus :: Lens' UpdateReplicationSetResponse Int Source #
The response's http status code.
UpdateResponsePlan
updateResponsePlan_actions :: Lens' UpdateResponsePlan (Maybe [Action]) Source #
The actions that this response plan takes at the beginning of an incident.
updateResponsePlan_chatChannel :: Lens' UpdateResponsePlan (Maybe ChatChannel) Source #
The Chatbot chat channel used for collaboration during an incident.
Use the empty structure to remove the chat channel from the response plan.
updateResponsePlan_clientToken :: Lens' UpdateResponsePlan (Maybe Text) Source #
A token ensuring that the operation is called only once with the specified details.
updateResponsePlan_displayName :: Lens' UpdateResponsePlan (Maybe Text) Source #
The long format name of the response plan. The display name can't contain spaces.
updateResponsePlan_engagements :: Lens' UpdateResponsePlan (Maybe [Text]) Source #
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
updateResponsePlan_incidentTemplateDedupeString :: Lens' UpdateResponsePlan (Maybe Text) Source #
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
updateResponsePlan_incidentTemplateImpact :: Lens' UpdateResponsePlan (Maybe Natural) Source #
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Possible impacts:
5
- Severe impact4
- High impact3
- Medium impact2
- Low impact1
- No impact
updateResponsePlan_incidentTemplateNotificationTargets :: Lens' UpdateResponsePlan (Maybe [NotificationTargetItem]) Source #
The Amazon SNS targets that are notified when updates are made to an incident.
updateResponsePlan_incidentTemplateSummary :: Lens' UpdateResponsePlan (Maybe Text) Source #
A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.
updateResponsePlan_incidentTemplateTags :: Lens' UpdateResponsePlan (Maybe (HashMap Text Text)) Source #
Tags to assign to the template. When the StartIncident
API action is
called, Incident Manager assigns the tags specified in the template to
the incident. To call this action, you must also have permission to call
the TagResource
API action for the incident record resource.
updateResponsePlan_incidentTemplateTitle :: Lens' UpdateResponsePlan (Maybe Text) Source #
The short format name of the incident. The title can't contain spaces.
updateResponsePlan_integrations :: Lens' UpdateResponsePlan (Maybe [Integration]) Source #
Information about third-party services integrated into the response plan.
updateResponsePlan_arn :: Lens' UpdateResponsePlan Text Source #
The Amazon Resource Name (ARN) of the response plan.
updateResponsePlanResponse_httpStatus :: Lens' UpdateResponsePlanResponse Int Source #
The response's http status code.
UpdateTimelineEvent
updateTimelineEvent_clientToken :: Lens' UpdateTimelineEvent (Maybe Text) Source #
A token ensuring that the operation is called only once with the specified details.
updateTimelineEvent_eventData :: Lens' UpdateTimelineEvent (Maybe Text) Source #
A short description of the event.
updateTimelineEvent_eventReferences :: Lens' UpdateTimelineEvent (Maybe [EventReference]) Source #
Updates all existing references in a TimelineEvent
. A reference can be
an Amazon Web Services resource involved in the incident or in some way
associated with it. When you specify a reference, you enter the Amazon
Resource Name (ARN) of the resource. You can also specify a related
item. As an example, you could specify the ARN of an Amazon DynamoDB
(DynamoDB) table. The table for this example is the resource. You could
also specify a Amazon CloudWatch metric for that table. The metric is
the related item.
This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes them and enters only new references.
updateTimelineEvent_eventTime :: Lens' UpdateTimelineEvent (Maybe UTCTime) Source #
The time that the event occurred.
updateTimelineEvent_eventType :: Lens' UpdateTimelineEvent (Maybe Text) Source #
The type of the event. You can update events of type Custom Event
.
updateTimelineEvent_eventId :: Lens' UpdateTimelineEvent Text Source #
The ID of the event you are updating. You can find this by using
ListTimelineEvents
.
updateTimelineEvent_incidentRecordArn :: Lens' UpdateTimelineEvent Text Source #
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
updateTimelineEventResponse_httpStatus :: Lens' UpdateTimelineEventResponse Int Source #
The response's http status code.
Types
Action
action_ssmAutomation :: Lens' Action (Maybe SsmAutomation) Source #
The Systems Manager automation document to start as the runbook at the beginning of the incident.
AddRegionAction
addRegionAction_sseKmsKeyId :: Lens' AddRegionAction (Maybe Text) Source #
The KMS key ID to use to encrypt your replication set.
addRegionAction_regionName :: Lens' AddRegionAction Text Source #
The Amazon Web Services Region name to add to the replication set.
AttributeValueList
attributeValueList_integerValues :: Lens' AttributeValueList (Maybe [Int]) Source #
The list of integer values that the filter matches.
attributeValueList_stringValues :: Lens' AttributeValueList (Maybe [Text]) Source #
The list of string values that the filter matches.
AutomationExecution
automationExecution_ssmExecutionArn :: Lens' AutomationExecution (Maybe Text) Source #
The Amazon Resource Name (ARN) of the automation process.
ChatChannel
chatChannel_chatbotSns :: Lens' ChatChannel (Maybe (NonEmpty Text)) Source #
The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics.
chatChannel_empty :: Lens' ChatChannel (Maybe EmptyChatChannel) Source #
Used to remove the chat channel from an incident record or response plan.
Condition
condition_equals :: Lens' Condition (Maybe AttributeValueList) Source #
The value is equal to the provided string or integer.
DeleteRegionAction
deleteRegionAction_regionName :: Lens' DeleteRegionAction Text Source #
The name of the Amazon Web Services Region you're deleting from the replication set.
DynamicSsmParameterValue
dynamicSsmParameterValue_variable :: Lens' DynamicSsmParameterValue (Maybe VariableType) Source #
Variable dynamic parameters. A parameter value is determined when an incident is created.
EmptyChatChannel
EventReference
eventReference_relatedItemId :: Lens' EventReference (Maybe Text) Source #
The ID of a RelatedItem
referenced in a TimelineEvent
.
eventReference_resource :: Lens' EventReference (Maybe Text) Source #
The Amazon Resource Name (ARN) of an Amazon Web Services resource
referenced in a TimelineEvent
.
EventSummary
eventSummary_eventReferences :: Lens' EventSummary (Maybe [EventReference]) Source #
A list of references in a TimelineEvent
.
eventSummary_eventId :: Lens' EventSummary Text Source #
The timeline event ID.
eventSummary_eventTime :: Lens' EventSummary UTCTime Source #
The time that the event occurred.
eventSummary_eventType :: Lens' EventSummary Text Source #
The type of event. The timeline event must be Custom Event
.
eventSummary_eventUpdatedTime :: Lens' EventSummary UTCTime Source #
The time that the timeline event was last updated.
eventSummary_incidentRecordArn :: Lens' EventSummary Text Source #
The Amazon Resource Name (ARN) of the incident that the event happened during.
Filter
filter_condition :: Lens' Filter Condition Source #
The condition accepts before or after a specified time, equal to a string, or equal to an integer.
IncidentRecord
incidentRecord_automationExecutions :: Lens' IncidentRecord (Maybe [AutomationExecution]) Source #
The runbook, or automation document, that's run at the beginning of the incident.
incidentRecord_chatChannel :: Lens' IncidentRecord (Maybe ChatChannel) Source #
The chat channel used for collaboration during an incident.
incidentRecord_notificationTargets :: Lens' IncidentRecord (Maybe [NotificationTargetItem]) Source #
The Amazon SNS targets that are notified when updates are made to an incident.
incidentRecord_resolvedTime :: Lens' IncidentRecord (Maybe UTCTime) Source #
The time at which the incident was resolved. This appears as a timeline event.
incidentRecord_summary :: Lens' IncidentRecord (Maybe Text) Source #
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.
incidentRecord_arn :: Lens' IncidentRecord Text Source #
The Amazon Resource Name (ARN) of the incident record.
incidentRecord_creationTime :: Lens' IncidentRecord UTCTime Source #
The time that Incident Manager created the incident record.
incidentRecord_dedupeString :: Lens' IncidentRecord Text Source #
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
incidentRecord_impact :: Lens' IncidentRecord Natural Source #
The impact of the incident on customers and applications.
incidentRecord_incidentRecordSource :: Lens' IncidentRecord IncidentRecordSource Source #
Details about the action that started the incident.
incidentRecord_lastModifiedBy :: Lens' IncidentRecord Text Source #
Who modified the incident most recently.
incidentRecord_lastModifiedTime :: Lens' IncidentRecord UTCTime Source #
The time at which the incident was most recently modified.
incidentRecord_status :: Lens' IncidentRecord IncidentRecordStatus Source #
The current status of the incident.
incidentRecord_title :: Lens' IncidentRecord Text Source #
The title of the incident.
IncidentRecordSource
incidentRecordSource_invokedBy :: Lens' IncidentRecordSource (Maybe Text) Source #
The service principal that assumed the role specified in createdBy
. If
no service principal assumed the role this will be left blank.
incidentRecordSource_resourceArn :: Lens' IncidentRecordSource (Maybe Text) Source #
The resource that caused the incident to be created.
incidentRecordSource_createdBy :: Lens' IncidentRecordSource Text Source #
The principal that started the incident.
incidentRecordSource_source :: Lens' IncidentRecordSource Text Source #
The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event.
IncidentRecordSummary
incidentRecordSummary_resolvedTime :: Lens' IncidentRecordSummary (Maybe UTCTime) Source #
The time the incident was resolved.
incidentRecordSummary_arn :: Lens' IncidentRecordSummary Text Source #
The Amazon Resource Name (ARN) of the incident.
incidentRecordSummary_creationTime :: Lens' IncidentRecordSummary UTCTime Source #
The time the incident was created.
incidentRecordSummary_impact :: Lens' IncidentRecordSummary Natural Source #
Defines the impact to customers and applications.
incidentRecordSummary_incidentRecordSource :: Lens' IncidentRecordSummary IncidentRecordSource Source #
What caused Incident Manager to create the incident.
incidentRecordSummary_status :: Lens' IncidentRecordSummary IncidentRecordStatus Source #
The current status of the incident.
incidentRecordSummary_title :: Lens' IncidentRecordSummary Text Source #
The title of the incident. This value is either provided by the response plan or overwritten on creation.
IncidentTemplate
incidentTemplate_dedupeString :: Lens' IncidentTemplate (Maybe Text) Source #
Used to stop Incident Manager from creating multiple incident records for the same incident.
incidentTemplate_incidentTags :: Lens' IncidentTemplate (Maybe (HashMap Text Text)) Source #
Tags to assign to the template. When the StartIncident
API action is
called, Incident Manager assigns the tags specified in the template to
the incident.
incidentTemplate_notificationTargets :: Lens' IncidentTemplate (Maybe [NotificationTargetItem]) Source #
The Amazon SNS targets that are notified when updates are made to an incident.
incidentTemplate_summary :: Lens' IncidentTemplate (Maybe Text) Source #
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
incidentTemplate_impact :: Lens' IncidentTemplate Natural Source #
The impact of the incident on your customers and applications.
incidentTemplate_title :: Lens' IncidentTemplate Text Source #
The title of the incident.
Integration
integration_pagerDutyConfiguration :: Lens' Integration (Maybe PagerDutyConfiguration) Source #
Information about the PagerDuty service where the response plan creates an incident.
ItemIdentifier
itemIdentifier_type :: Lens' ItemIdentifier ItemType Source #
The type of related item.
itemIdentifier_value :: Lens' ItemIdentifier ItemValue Source #
Details about the related item.
ItemValue
itemValue_arn :: Lens' ItemValue (Maybe Text) Source #
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
itemValue_metricDefinition :: Lens' ItemValue (Maybe Text) Source #
The metric definition, if the related item is a metric in Amazon CloudWatch.
itemValue_pagerDutyIncidentDetail :: Lens' ItemValue (Maybe PagerDutyIncidentDetail) Source #
Details about an incident that is associated with a PagerDuty incident.
itemValue_url :: Lens' ItemValue (Maybe Text) Source #
The URL, if the related item is a non-Amazon Web Services resource.
NotificationTargetItem
notificationTargetItem_snsTopicArn :: Lens' NotificationTargetItem (Maybe Text) Source #
The Amazon Resource Name (ARN) of the SNS topic.
PagerDutyConfiguration
pagerDutyConfiguration_name :: Lens' PagerDutyConfiguration Text Source #
The name of the PagerDuty configuration.
pagerDutyConfiguration_pagerDutyIncidentConfiguration :: Lens' PagerDutyConfiguration PagerDutyIncidentConfiguration Source #
Details about the PagerDuty service associated with the configuration.
pagerDutyConfiguration_secretId :: Lens' PagerDutyConfiguration Text Source #
The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.
PagerDutyIncidentConfiguration
pagerDutyIncidentConfiguration_serviceId :: Lens' PagerDutyIncidentConfiguration Text Source #
The ID of the PagerDuty service that the response plan associates with an incident when it launches.
PagerDutyIncidentDetail
pagerDutyIncidentDetail_autoResolve :: Lens' PagerDutyIncidentDetail (Maybe Bool) Source #
Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.
pagerDutyIncidentDetail_secretId :: Lens' PagerDutyIncidentDetail (Maybe Text) Source #
The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.
pagerDutyIncidentDetail_id :: Lens' PagerDutyIncidentDetail Text Source #
The ID of the incident associated with the PagerDuty service for the response plan.
RegionInfo
regionInfo_sseKmsKeyId :: Lens' RegionInfo (Maybe Text) Source #
The ID of the KMS key used to encrypt the data in this Amazon Web Services Region.
regionInfo_statusMessage :: Lens' RegionInfo (Maybe Text) Source #
Information displayed about the status of the Amazon Web Services Region.
regionInfo_status :: Lens' RegionInfo RegionStatus Source #
The status of the Amazon Web Services Region in the replication set.
regionInfo_statusUpdateDateTime :: Lens' RegionInfo UTCTime Source #
The most recent date and time that Incident Manager updated the Amazon Web Services Region's status.
RegionMapInputValue
regionMapInputValue_sseKmsKeyId :: Lens' RegionMapInputValue (Maybe Text) Source #
The KMS key used to encrypt the data in your replication set.
RelatedItem
relatedItem_generatedId :: Lens' RelatedItem (Maybe Text) Source #
A unique ID for a RelatedItem
.
Don't specify this parameter when you add a RelatedItem
by using the
UpdateRelatedItems API action.
relatedItem_title :: Lens' RelatedItem (Maybe Text) Source #
The title of the related item.
relatedItem_identifier :: Lens' RelatedItem ItemIdentifier Source #
Details about the related item.
RelatedItemsUpdate
relatedItemsUpdate_itemToAdd :: Lens' RelatedItemsUpdate (Maybe RelatedItem) Source #
Details about the related item you're adding.
relatedItemsUpdate_itemToRemove :: Lens' RelatedItemsUpdate (Maybe ItemIdentifier) Source #
Details about the related item you're deleting.
ReplicationSet
replicationSet_arn :: Lens' ReplicationSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the replication set.
replicationSet_createdBy :: Lens' ReplicationSet Text Source #
Details about who created the replication set.
replicationSet_createdTime :: Lens' ReplicationSet UTCTime Source #
When the replication set was created.
replicationSet_deletionProtected :: Lens' ReplicationSet Bool Source #
Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Amazon Web Services Region in the replication set.
replicationSet_lastModifiedBy :: Lens' ReplicationSet Text Source #
Who last modified the replication set.
replicationSet_lastModifiedTime :: Lens' ReplicationSet UTCTime Source #
When the replication set was last updated.
replicationSet_regionMap :: Lens' ReplicationSet (HashMap Text RegionInfo) Source #
The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.
replicationSet_status :: Lens' ReplicationSet ReplicationSetStatus Source #
The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.
ResourcePolicy
resourcePolicy_policyDocument :: Lens' ResourcePolicy Text Source #
The JSON blob that describes the policy.
resourcePolicy_policyId :: Lens' ResourcePolicy Text Source #
The ID of the resource policy.
resourcePolicy_ramResourceShareRegion :: Lens' ResourcePolicy Text Source #
The Amazon Web Services Region that policy allows resources to be used in.
ResponsePlanSummary
responsePlanSummary_displayName :: Lens' ResponsePlanSummary (Maybe Text) Source #
The human readable name of the response plan. This can include spaces.
responsePlanSummary_arn :: Lens' ResponsePlanSummary Text Source #
The Amazon Resource Name (ARN) of the response plan.
responsePlanSummary_name :: Lens' ResponsePlanSummary Text Source #
The name of the response plan. This can't include spaces.
SsmAutomation
ssmAutomation_documentVersion :: Lens' SsmAutomation (Maybe Text) Source #
The automation document's version to use when running.
ssmAutomation_dynamicParameters :: Lens' SsmAutomation (Maybe (HashMap Text DynamicSsmParameterValue)) Source #
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
ssmAutomation_parameters :: Lens' SsmAutomation (Maybe (HashMap Text [Text])) Source #
The key-value pair parameters to use when running the automation document.
ssmAutomation_targetAccount :: Lens' SsmAutomation (Maybe SsmTargetAccount) Source #
The account that the automation document will be run in. This can be in either the management account or an application account.
ssmAutomation_documentName :: Lens' SsmAutomation Text Source #
The automation document's name.
ssmAutomation_roleArn :: Lens' SsmAutomation Text Source #
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
TimelineEvent
timelineEvent_eventReferences :: Lens' TimelineEvent (Maybe [EventReference]) Source #
A list of references in a TimelineEvent
.
timelineEvent_eventData :: Lens' TimelineEvent Text Source #
A short description of the event.
timelineEvent_eventId :: Lens' TimelineEvent Text Source #
The ID of the timeline event.
timelineEvent_eventTime :: Lens' TimelineEvent UTCTime Source #
The time that the event occurred.
timelineEvent_eventType :: Lens' TimelineEvent Text Source #
The type of event that occurred. Currently Incident Manager supports
only the Custom Event
type.
timelineEvent_eventUpdatedTime :: Lens' TimelineEvent UTCTime Source #
The time that the timeline event was last updated.
timelineEvent_incidentRecordArn :: Lens' TimelineEvent Text Source #
The Amazon Resource Name (ARN) of the incident that the event occurred during.
TriggerDetails
triggerDetails_rawData :: Lens' TriggerDetails (Maybe Text) Source #
Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created.
triggerDetails_triggerArn :: Lens' TriggerDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the source that detected the incident.
triggerDetails_source :: Lens' TriggerDetails Text Source #
Identifies the service that sourced the event. All events sourced from
within Amazon Web Services begin with "aws.
" Customer-generated
events can have any value here, as long as it doesn't begin with
"aws.
" We recommend the use of Java package-name style reverse
domain-name strings.
triggerDetails_timestamp :: Lens' TriggerDetails UTCTime Source #
The time that the incident was detected.
UpdateReplicationSetAction
updateReplicationSetAction_addRegionAction :: Lens' UpdateReplicationSetAction (Maybe AddRegionAction) Source #
Details about the Amazon Web Services Region that you're adding to the replication set.
updateReplicationSetAction_deleteRegionAction :: Lens' UpdateReplicationSetAction (Maybe DeleteRegionAction) Source #
Details about the Amazon Web Services Region that you're deleting to the replication set.