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 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateReplicationSet
- CreateResponsePlan
- CreateTimelineEvent
- DeleteIncidentRecord
- DeleteReplicationSet
- DeleteResourcePolicy
- DeleteResponsePlan
- DeleteTimelineEvent
- GetIncidentRecord
- GetReplicationSet
- GetResourcePolicies (Paginated)
- GetResponsePlan
- GetTimelineEvent
- ListIncidentRecords (Paginated)
- ListRelatedItems (Paginated)
- ListReplicationSets (Paginated)
- ListResponsePlans (Paginated)
- ListTagsForResource
- ListTimelineEvents (Paginated)
- PutResourcePolicy
- StartIncident
- TagResource
- UntagResource
- UpdateDeletionProtection
- UpdateIncidentRecord
- UpdateRelatedItems
- UpdateReplicationSet
- UpdateResponsePlan
- UpdateTimelineEvent
- Types
- IncidentRecordStatus
- ItemType
- RegionStatus
- ReplicationSetStatus
- SortOrder
- SsmTargetAccount
- TimelineEventSort
- VariableType
- 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
Derived from API version 2018-05-10
of the AWS service descriptions, licensed under Apache 2.0.
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newWaitForReplicationSetActive :: Wait GetReplicationSet
- newWaitForReplicationSetDeleted :: Wait GetReplicationSet
- data CreateReplicationSet = CreateReplicationSet' (Maybe Text) (Maybe (HashMap Text Text)) (HashMap Text RegionMapInputValue)
- newCreateReplicationSet :: CreateReplicationSet
- data CreateReplicationSetResponse = CreateReplicationSetResponse' Int Text
- newCreateReplicationSetResponse :: Int -> Text -> CreateReplicationSetResponse
- data CreateResponsePlan = CreateResponsePlan' (Maybe [Action]) (Maybe ChatChannel) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Integration]) (Maybe (HashMap Text Text)) IncidentTemplate Text
- newCreateResponsePlan :: IncidentTemplate -> Text -> CreateResponsePlan
- data CreateResponsePlanResponse = CreateResponsePlanResponse' Int Text
- newCreateResponsePlanResponse :: Int -> Text -> CreateResponsePlanResponse
- data CreateTimelineEvent = CreateTimelineEvent' (Maybe Text) (Maybe [EventReference]) Text POSIX Text Text
- newCreateTimelineEvent :: Text -> UTCTime -> Text -> Text -> CreateTimelineEvent
- data CreateTimelineEventResponse = CreateTimelineEventResponse' Int Text Text
- newCreateTimelineEventResponse :: Int -> Text -> Text -> CreateTimelineEventResponse
- data DeleteIncidentRecord = DeleteIncidentRecord' Text
- newDeleteIncidentRecord :: Text -> DeleteIncidentRecord
- data DeleteIncidentRecordResponse = DeleteIncidentRecordResponse' Int
- newDeleteIncidentRecordResponse :: Int -> DeleteIncidentRecordResponse
- data DeleteReplicationSet = DeleteReplicationSet' Text
- newDeleteReplicationSet :: Text -> DeleteReplicationSet
- data DeleteReplicationSetResponse = DeleteReplicationSetResponse' Int
- newDeleteReplicationSetResponse :: Int -> DeleteReplicationSetResponse
- data DeleteResourcePolicy = DeleteResourcePolicy' Text Text
- newDeleteResourcePolicy :: Text -> Text -> DeleteResourcePolicy
- data DeleteResourcePolicyResponse = DeleteResourcePolicyResponse' Int
- newDeleteResourcePolicyResponse :: Int -> DeleteResourcePolicyResponse
- data DeleteResponsePlan = DeleteResponsePlan' Text
- newDeleteResponsePlan :: Text -> DeleteResponsePlan
- data DeleteResponsePlanResponse = DeleteResponsePlanResponse' Int
- newDeleteResponsePlanResponse :: Int -> DeleteResponsePlanResponse
- data DeleteTimelineEvent = DeleteTimelineEvent' Text Text
- newDeleteTimelineEvent :: Text -> Text -> DeleteTimelineEvent
- data DeleteTimelineEventResponse = DeleteTimelineEventResponse' Int
- newDeleteTimelineEventResponse :: Int -> DeleteTimelineEventResponse
- data GetIncidentRecord = GetIncidentRecord' Text
- newGetIncidentRecord :: Text -> GetIncidentRecord
- data GetIncidentRecordResponse = GetIncidentRecordResponse' Int IncidentRecord
- newGetIncidentRecordResponse :: Int -> IncidentRecord -> GetIncidentRecordResponse
- data GetReplicationSet = GetReplicationSet' Text
- newGetReplicationSet :: Text -> GetReplicationSet
- data GetReplicationSetResponse = GetReplicationSetResponse' Int ReplicationSet
- newGetReplicationSetResponse :: Int -> ReplicationSet -> GetReplicationSetResponse
- data GetResourcePolicies = GetResourcePolicies' (Maybe Natural) (Maybe Text) Text
- newGetResourcePolicies :: Text -> GetResourcePolicies
- data GetResourcePoliciesResponse = GetResourcePoliciesResponse' (Maybe Text) Int [ResourcePolicy]
- newGetResourcePoliciesResponse :: Int -> GetResourcePoliciesResponse
- data GetResponsePlan = GetResponsePlan' Text
- newGetResponsePlan :: Text -> GetResponsePlan
- data GetResponsePlanResponse = GetResponsePlanResponse' (Maybe [Action]) (Maybe ChatChannel) (Maybe Text) (Maybe [Text]) (Maybe [Integration]) Int Text IncidentTemplate Text
- newGetResponsePlanResponse :: Int -> Text -> IncidentTemplate -> Text -> GetResponsePlanResponse
- data GetTimelineEvent = GetTimelineEvent' Text Text
- newGetTimelineEvent :: Text -> Text -> GetTimelineEvent
- data GetTimelineEventResponse = GetTimelineEventResponse' Int TimelineEvent
- newGetTimelineEventResponse :: Int -> TimelineEvent -> GetTimelineEventResponse
- data ListIncidentRecords = ListIncidentRecords' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListIncidentRecords :: ListIncidentRecords
- data ListIncidentRecordsResponse = ListIncidentRecordsResponse' (Maybe Text) Int [IncidentRecordSummary]
- newListIncidentRecordsResponse :: Int -> ListIncidentRecordsResponse
- data ListRelatedItems = ListRelatedItems' (Maybe Natural) (Maybe Text) Text
- newListRelatedItems :: Text -> ListRelatedItems
- data ListRelatedItemsResponse = ListRelatedItemsResponse' (Maybe Text) Int [RelatedItem]
- newListRelatedItemsResponse :: Int -> ListRelatedItemsResponse
- data ListReplicationSets = ListReplicationSets' (Maybe Natural) (Maybe Text)
- newListReplicationSets :: ListReplicationSets
- data ListReplicationSetsResponse = ListReplicationSetsResponse' (Maybe Text) Int [Text]
- newListReplicationSetsResponse :: Int -> ListReplicationSetsResponse
- data ListResponsePlans = ListResponsePlans' (Maybe Natural) (Maybe Text)
- newListResponsePlans :: ListResponsePlans
- data ListResponsePlansResponse = ListResponsePlansResponse' (Maybe Text) Int [ResponsePlanSummary]
- newListResponsePlansResponse :: Int -> ListResponsePlansResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' Int (HashMap Text Text)
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTimelineEvents = ListTimelineEvents' (Maybe [Filter]) (Maybe Natural) (Maybe Text) (Maybe TimelineEventSort) (Maybe SortOrder) Text
- newListTimelineEvents :: Text -> ListTimelineEvents
- data ListTimelineEventsResponse = ListTimelineEventsResponse' (Maybe Text) Int [EventSummary]
- newListTimelineEventsResponse :: Int -> ListTimelineEventsResponse
- data PutResourcePolicy = PutResourcePolicy' Text Text
- newPutResourcePolicy :: Text -> Text -> PutResourcePolicy
- data PutResourcePolicyResponse = PutResourcePolicyResponse' Int Text
- newPutResourcePolicyResponse :: Int -> Text -> PutResourcePolicyResponse
- data StartIncident = StartIncident' (Maybe Text) (Maybe Natural) (Maybe [RelatedItem]) (Maybe Text) (Maybe TriggerDetails) Text
- newStartIncident :: Text -> StartIncident
- data StartIncidentResponse = StartIncidentResponse' Int Text
- newStartIncidentResponse :: Int -> Text -> StartIncidentResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDeletionProtection = UpdateDeletionProtection' (Maybe Text) Text Bool
- newUpdateDeletionProtection :: Text -> Bool -> UpdateDeletionProtection
- data UpdateDeletionProtectionResponse = UpdateDeletionProtectionResponse' Int
- newUpdateDeletionProtectionResponse :: Int -> UpdateDeletionProtectionResponse
- data UpdateIncidentRecord = UpdateIncidentRecord' (Maybe ChatChannel) (Maybe Text) (Maybe Natural) (Maybe [NotificationTargetItem]) (Maybe IncidentRecordStatus) (Maybe Text) (Maybe Text) Text
- newUpdateIncidentRecord :: Text -> UpdateIncidentRecord
- data UpdateIncidentRecordResponse = UpdateIncidentRecordResponse' Int
- newUpdateIncidentRecordResponse :: Int -> UpdateIncidentRecordResponse
- data UpdateRelatedItems = UpdateRelatedItems' (Maybe Text) Text RelatedItemsUpdate
- newUpdateRelatedItems :: Text -> RelatedItemsUpdate -> UpdateRelatedItems
- data UpdateRelatedItemsResponse = UpdateRelatedItemsResponse' Int
- newUpdateRelatedItemsResponse :: Int -> UpdateRelatedItemsResponse
- data UpdateReplicationSet = UpdateReplicationSet' (Maybe Text) (NonEmpty UpdateReplicationSetAction) Text
- newUpdateReplicationSet :: NonEmpty UpdateReplicationSetAction -> Text -> UpdateReplicationSet
- data UpdateReplicationSetResponse = UpdateReplicationSetResponse' Int
- newUpdateReplicationSetResponse :: Int -> UpdateReplicationSetResponse
- data UpdateResponsePlan = UpdateResponsePlan' (Maybe [Action]) (Maybe ChatChannel) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Natural) (Maybe [NotificationTargetItem]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Integration]) Text
- newUpdateResponsePlan :: Text -> UpdateResponsePlan
- data UpdateResponsePlanResponse = UpdateResponsePlanResponse' Int
- newUpdateResponsePlanResponse :: Int -> UpdateResponsePlanResponse
- data UpdateTimelineEvent = UpdateTimelineEvent' (Maybe Text) (Maybe Text) (Maybe [EventReference]) (Maybe POSIX) (Maybe Text) Text Text
- newUpdateTimelineEvent :: Text -> Text -> UpdateTimelineEvent
- data UpdateTimelineEventResponse = UpdateTimelineEventResponse' Int
- newUpdateTimelineEventResponse :: Int -> UpdateTimelineEventResponse
- newtype IncidentRecordStatus where
- newtype ItemType where
- ItemType' {
- fromItemType :: Text
- pattern ItemType_ANALYSIS :: ItemType
- pattern ItemType_ATTACHMENT :: ItemType
- pattern ItemType_AUTOMATION :: ItemType
- pattern ItemType_INCIDENT :: ItemType
- pattern ItemType_INVOLVED_RESOURCE :: ItemType
- pattern ItemType_METRIC :: ItemType
- pattern ItemType_OTHER :: ItemType
- pattern ItemType_PARENT :: ItemType
- pattern ItemType_TASK :: ItemType
- ItemType' {
- newtype RegionStatus where
- RegionStatus' { }
- pattern RegionStatus_ACTIVE :: RegionStatus
- pattern RegionStatus_CREATING :: RegionStatus
- pattern RegionStatus_DELETING :: RegionStatus
- pattern RegionStatus_FAILED :: RegionStatus
- newtype ReplicationSetStatus where
- ReplicationSetStatus' { }
- pattern ReplicationSetStatus_ACTIVE :: ReplicationSetStatus
- pattern ReplicationSetStatus_CREATING :: ReplicationSetStatus
- pattern ReplicationSetStatus_DELETING :: ReplicationSetStatus
- pattern ReplicationSetStatus_FAILED :: ReplicationSetStatus
- pattern ReplicationSetStatus_UPDATING :: ReplicationSetStatus
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASCENDING :: SortOrder
- pattern SortOrder_DESCENDING :: SortOrder
- newtype SsmTargetAccount where
- newtype TimelineEventSort where
- newtype VariableType where
- VariableType' { }
- pattern VariableType_INCIDENT_RECORD_ARN :: VariableType
- pattern VariableType_INVOLVED_RESOURCES :: VariableType
- data Action = Action' (Maybe SsmAutomation)
- newAction :: Action
- data AddRegionAction = AddRegionAction' (Maybe Text) Text
- newAddRegionAction :: Text -> AddRegionAction
- data AttributeValueList = AttributeValueList' (Maybe [Int]) (Maybe [Text])
- newAttributeValueList :: AttributeValueList
- data AutomationExecution = AutomationExecution' (Maybe Text)
- newAutomationExecution :: AutomationExecution
- data ChatChannel = ChatChannel' (Maybe (NonEmpty Text)) (Maybe EmptyChatChannel)
- newChatChannel :: ChatChannel
- data Condition = Condition' (Maybe POSIX) (Maybe POSIX) (Maybe AttributeValueList)
- newCondition :: Condition
- data DeleteRegionAction = DeleteRegionAction' Text
- newDeleteRegionAction :: Text -> DeleteRegionAction
- data DynamicSsmParameterValue = DynamicSsmParameterValue' (Maybe VariableType)
- newDynamicSsmParameterValue :: DynamicSsmParameterValue
- data EmptyChatChannel = EmptyChatChannel' {
- newEmptyChatChannel :: EmptyChatChannel
- data EventReference = EventReference' (Maybe Text) (Maybe Text)
- newEventReference :: EventReference
- data EventSummary = EventSummary' (Maybe [EventReference]) Text POSIX Text POSIX Text
- newEventSummary :: Text -> UTCTime -> Text -> UTCTime -> Text -> EventSummary
- data Filter = Filter' Condition Text
- newFilter :: Condition -> Text -> Filter
- data IncidentRecord = IncidentRecord' (Maybe [AutomationExecution]) (Maybe ChatChannel) (Maybe [NotificationTargetItem]) (Maybe POSIX) (Maybe Text) Text POSIX Text Natural IncidentRecordSource Text POSIX IncidentRecordStatus Text
- newIncidentRecord :: Text -> UTCTime -> Text -> Natural -> IncidentRecordSource -> Text -> UTCTime -> IncidentRecordStatus -> Text -> IncidentRecord
- data IncidentRecordSource = IncidentRecordSource' (Maybe Text) (Maybe Text) Text Text
- newIncidentRecordSource :: Text -> Text -> IncidentRecordSource
- data IncidentRecordSummary = IncidentRecordSummary' (Maybe POSIX) Text POSIX Natural IncidentRecordSource IncidentRecordStatus Text
- newIncidentRecordSummary :: Text -> UTCTime -> Natural -> IncidentRecordSource -> IncidentRecordStatus -> Text -> IncidentRecordSummary
- data IncidentTemplate = IncidentTemplate' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [NotificationTargetItem]) (Maybe Text) Natural Text
- newIncidentTemplate :: Natural -> Text -> IncidentTemplate
- data Integration = Integration' (Maybe PagerDutyConfiguration)
- newIntegration :: Integration
- data ItemIdentifier = ItemIdentifier' ItemType ItemValue
- newItemIdentifier :: ItemType -> ItemValue -> ItemIdentifier
- data ItemValue = ItemValue' (Maybe Text) (Maybe Text) (Maybe PagerDutyIncidentDetail) (Maybe Text)
- newItemValue :: ItemValue
- data NotificationTargetItem = NotificationTargetItem' (Maybe Text)
- newNotificationTargetItem :: NotificationTargetItem
- data PagerDutyConfiguration = PagerDutyConfiguration' Text PagerDutyIncidentConfiguration Text
- newPagerDutyConfiguration :: Text -> PagerDutyIncidentConfiguration -> Text -> PagerDutyConfiguration
- data PagerDutyIncidentConfiguration = PagerDutyIncidentConfiguration' Text
- newPagerDutyIncidentConfiguration :: Text -> PagerDutyIncidentConfiguration
- data PagerDutyIncidentDetail = PagerDutyIncidentDetail' (Maybe Bool) (Maybe Text) Text
- newPagerDutyIncidentDetail :: Text -> PagerDutyIncidentDetail
- data RegionInfo = RegionInfo' (Maybe Text) (Maybe Text) RegionStatus POSIX
- newRegionInfo :: RegionStatus -> UTCTime -> RegionInfo
- data RegionMapInputValue = RegionMapInputValue' (Maybe Text)
- newRegionMapInputValue :: RegionMapInputValue
- data RelatedItem = RelatedItem' (Maybe Text) (Maybe Text) ItemIdentifier
- newRelatedItem :: ItemIdentifier -> RelatedItem
- data RelatedItemsUpdate = RelatedItemsUpdate' (Maybe RelatedItem) (Maybe ItemIdentifier)
- newRelatedItemsUpdate :: RelatedItemsUpdate
- data ReplicationSet = ReplicationSet' (Maybe Text) Text POSIX Bool Text POSIX (HashMap Text RegionInfo) ReplicationSetStatus
- newReplicationSet :: Text -> UTCTime -> Bool -> Text -> UTCTime -> ReplicationSetStatus -> ReplicationSet
- data ResourcePolicy = ResourcePolicy' Text Text Text
- newResourcePolicy :: Text -> Text -> Text -> ResourcePolicy
- data ResponsePlanSummary = ResponsePlanSummary' (Maybe Text) Text Text
- newResponsePlanSummary :: Text -> Text -> ResponsePlanSummary
- data SsmAutomation = SsmAutomation' (Maybe Text) (Maybe (HashMap Text DynamicSsmParameterValue)) (Maybe (HashMap Text [Text])) (Maybe SsmTargetAccount) Text Text
- newSsmAutomation :: Text -> Text -> SsmAutomation
- data TimelineEvent = TimelineEvent' (Maybe [EventReference]) Text Text POSIX Text POSIX Text
- newTimelineEvent :: Text -> Text -> UTCTime -> Text -> UTCTime -> Text -> TimelineEvent
- data TriggerDetails = TriggerDetails' (Maybe Text) (Maybe Text) Text POSIX
- newTriggerDetails :: Text -> UTCTime -> TriggerDetails
- data UpdateReplicationSetAction = UpdateReplicationSetAction' (Maybe AddRegionAction) (Maybe DeleteRegionAction)
- newUpdateReplicationSetAction :: UpdateReplicationSetAction
Service Configuration
defaultService :: Service Source #
API version 2018-05-10
of the Amazon Systems Manager Incident Manager SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SSMIncidents
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient access to perform this operation.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Updating or deleting a resource causes an inconsistent state.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Request references a resource which doesn't exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
Request would cause a service quota to be exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an Amazon Web Services service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
WaitForReplicationSetActive
newWaitForReplicationSetActive :: Wait GetReplicationSet Source #
Polls GetReplicationSet
every 30 seconds until a successful state is reached. An error is returned after 5 failed checks.
WaitForReplicationSetDeleted
newWaitForReplicationSetDeleted :: Wait GetReplicationSet Source #
Polls GetReplicationSet
every 30 seconds until a successful state is reached. An error is returned after 5 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateReplicationSet
data CreateReplicationSet Source #
See: newCreateReplicationSet
smart constructor.
Instances
newCreateReplicationSet :: CreateReplicationSet Source #
Create a value of CreateReplicationSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateReplicationSet'
, createReplicationSet_clientToken
- A token that ensures that the operation is called only once with the
specified details.
$sel:tags:CreateReplicationSet'
, createReplicationSet_tags
- A list of tags to add to the replication set.
$sel:regions:CreateReplicationSet'
, createReplicationSet_regions
- The Regions that Incident Manager replicates your data to. You can have
up to three Regions in your replication set.
data CreateReplicationSetResponse Source #
See: newCreateReplicationSetResponse
smart constructor.
Instances
newCreateReplicationSetResponse Source #
:: Int | |
-> Text | |
-> CreateReplicationSetResponse |
Create a value of CreateReplicationSetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateReplicationSetResponse'
, createReplicationSetResponse_httpStatus
- The response's http status code.
CreateReplicationSetResponse
, createReplicationSetResponse_arn
- The Amazon Resource Name (ARN) of the replication set.
CreateResponsePlan
data CreateResponsePlan Source #
See: newCreateResponsePlan
smart constructor.
CreateResponsePlan' (Maybe [Action]) (Maybe ChatChannel) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Integration]) (Maybe (HashMap Text Text)) IncidentTemplate Text |
Instances
newCreateResponsePlan Source #
Create a value of CreateResponsePlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actions:CreateResponsePlan'
, createResponsePlan_actions
- The actions that the response plan starts at the beginning of an
incident.
CreateResponsePlan
, createResponsePlan_chatChannel
- The Chatbot chat channel used for collaboration during an incident.
$sel:clientToken:CreateResponsePlan'
, createResponsePlan_clientToken
- A token ensuring that the operation is called only once with the
specified details.
CreateResponsePlan
, createResponsePlan_displayName
- The long format of the response plan name. This field can contain
spaces.
$sel:engagements:CreateResponsePlan'
, createResponsePlan_engagements
- The Amazon Resource Name (ARN) for the contacts and escalation plans
that the response plan engages during an incident.
$sel:integrations:CreateResponsePlan'
, createResponsePlan_integrations
- Information about third-party services integrated into the response
plan.
$sel:tags:CreateResponsePlan'
, createResponsePlan_tags
- A list of tags that you are adding to the response plan.
$sel:incidentTemplate:CreateResponsePlan'
, createResponsePlan_incidentTemplate
- Details used to create an incident when using this response plan.
CreateResponsePlan
, createResponsePlan_name
- The short format name of the response plan. Can't include spaces.
data CreateResponsePlanResponse Source #
See: newCreateResponsePlanResponse
smart constructor.
Instances
newCreateResponsePlanResponse Source #
:: Int | |
-> Text | |
-> CreateResponsePlanResponse |
Create a value of CreateResponsePlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateResponsePlanResponse'
, createResponsePlanResponse_httpStatus
- The response's http status code.
CreateResponsePlanResponse
, createResponsePlanResponse_arn
- The Amazon Resource Name (ARN) of the response plan.
CreateTimelineEvent
data CreateTimelineEvent Source #
See: newCreateTimelineEvent
smart constructor.
Instances
newCreateTimelineEvent Source #
:: Text | |
-> UTCTime | |
-> Text | |
-> Text | |
-> CreateTimelineEvent |
Create a value of CreateTimelineEvent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateTimelineEvent'
, createTimelineEvent_clientToken
- A token ensuring that the action is called only once with the specified
details.
CreateTimelineEvent
, createTimelineEvent_eventReferences
- 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
, createTimelineEvent_eventData
- A short description of the event.
CreateTimelineEvent
, createTimelineEvent_eventTime
- The time that the event occurred.
CreateTimelineEvent
, createTimelineEvent_eventType
- The type of the event. You can create timeline events of type
Custom Event
.
CreateTimelineEvent
, createTimelineEvent_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident record to which the event
will be added.
data CreateTimelineEventResponse Source #
See: newCreateTimelineEventResponse
smart constructor.
Instances
newCreateTimelineEventResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateTimelineEventResponse |
Create a value of CreateTimelineEventResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateTimelineEventResponse'
, createTimelineEventResponse_httpStatus
- The response's http status code.
CreateTimelineEventResponse
, createTimelineEventResponse_eventId
- The ID of the event for easy reference later.
CreateTimelineEvent
, createTimelineEventResponse_incidentRecordArn
- The ARN of the incident record that you added the event to.
DeleteIncidentRecord
data DeleteIncidentRecord Source #
See: newDeleteIncidentRecord
smart constructor.
Instances
newDeleteIncidentRecord Source #
Create a value of DeleteIncidentRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteIncidentRecord
, deleteIncidentRecord_arn
- The Amazon Resource Name (ARN) of the incident record you are deleting.
data DeleteIncidentRecordResponse Source #
See: newDeleteIncidentRecordResponse
smart constructor.
Instances
newDeleteIncidentRecordResponse Source #
Create a value of DeleteIncidentRecordResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteIncidentRecordResponse'
, deleteIncidentRecordResponse_httpStatus
- The response's http status code.
DeleteReplicationSet
data DeleteReplicationSet Source #
See: newDeleteReplicationSet
smart constructor.
Instances
newDeleteReplicationSet Source #
Create a value of DeleteReplicationSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteReplicationSet
, deleteReplicationSet_arn
- The Amazon Resource Name (ARN) of the replication set you're deleting.
data DeleteReplicationSetResponse Source #
See: newDeleteReplicationSetResponse
smart constructor.
Instances
newDeleteReplicationSetResponse Source #
Create a value of DeleteReplicationSetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteReplicationSetResponse'
, deleteReplicationSetResponse_httpStatus
- The response's http status code.
DeleteResourcePolicy
data DeleteResourcePolicy Source #
See: newDeleteResourcePolicy
smart constructor.
Instances
newDeleteResourcePolicy Source #
Create a value of DeleteResourcePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResourcePolicy
, deleteResourcePolicy_policyId
- The ID of the resource policy you're deleting.
DeleteResourcePolicy
, deleteResourcePolicy_resourceArn
- The Amazon Resource Name (ARN) of the resource you're deleting the
policy from.
data DeleteResourcePolicyResponse Source #
See: newDeleteResourcePolicyResponse
smart constructor.
Instances
newDeleteResourcePolicyResponse Source #
Create a value of DeleteResourcePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteResourcePolicyResponse'
, deleteResourcePolicyResponse_httpStatus
- The response's http status code.
DeleteResponsePlan
data DeleteResponsePlan Source #
See: newDeleteResponsePlan
smart constructor.
Instances
newDeleteResponsePlan Source #
Create a value of DeleteResponsePlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResponsePlan
, deleteResponsePlan_arn
- The Amazon Resource Name (ARN) of the response plan.
data DeleteResponsePlanResponse Source #
See: newDeleteResponsePlanResponse
smart constructor.
Instances
newDeleteResponsePlanResponse Source #
Create a value of DeleteResponsePlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteResponsePlanResponse'
, deleteResponsePlanResponse_httpStatus
- The response's http status code.
DeleteTimelineEvent
data DeleteTimelineEvent Source #
See: newDeleteTimelineEvent
smart constructor.
Instances
newDeleteTimelineEvent Source #
Create a value of DeleteTimelineEvent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteTimelineEvent
, deleteTimelineEvent_eventId
- The ID of the event you are updating. You can find this by using
ListTimelineEvents
.
DeleteTimelineEvent
, deleteTimelineEvent_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident that includes the
timeline event.
data DeleteTimelineEventResponse Source #
See: newDeleteTimelineEventResponse
smart constructor.
Instances
newDeleteTimelineEventResponse Source #
Create a value of DeleteTimelineEventResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteTimelineEventResponse'
, deleteTimelineEventResponse_httpStatus
- The response's http status code.
GetIncidentRecord
data GetIncidentRecord Source #
See: newGetIncidentRecord
smart constructor.
Instances
Create a value of GetIncidentRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetIncidentRecord
, getIncidentRecord_arn
- The Amazon Resource Name (ARN) of the incident record.
data GetIncidentRecordResponse Source #
See: newGetIncidentRecordResponse
smart constructor.
Instances
newGetIncidentRecordResponse Source #
Create a value of GetIncidentRecordResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetIncidentRecordResponse'
, getIncidentRecordResponse_httpStatus
- The response's http status code.
$sel:incidentRecord:GetIncidentRecordResponse'
, getIncidentRecordResponse_incidentRecord
- Details the structure of the incident record.
GetReplicationSet
data GetReplicationSet Source #
See: newGetReplicationSet
smart constructor.
Instances
Create a value of GetReplicationSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetReplicationSet
, getReplicationSet_arn
- The Amazon Resource Name (ARN) of the replication set you want to
retrieve.
data GetReplicationSetResponse Source #
See: newGetReplicationSetResponse
smart constructor.
Instances
newGetReplicationSetResponse Source #
Create a value of GetReplicationSetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetReplicationSetResponse'
, getReplicationSetResponse_httpStatus
- The response's http status code.
$sel:replicationSet:GetReplicationSetResponse'
, getReplicationSetResponse_replicationSet
- Details of the replication set.
GetResourcePolicies (Paginated)
data GetResourcePolicies Source #
See: newGetResourcePolicies
smart constructor.
Instances
newGetResourcePolicies Source #
Create a value of GetResourcePolicies
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetResourcePolicies'
, getResourcePolicies_maxResults
- The maximum number of resource policies to display for each page of
results.
GetResourcePolicies
, getResourcePolicies_nextToken
- The pagination token to continue to the next page of results.
GetResourcePolicies
, getResourcePolicies_resourceArn
- The Amazon Resource Name (ARN) of the response plan with the attached
resource policy.
data GetResourcePoliciesResponse Source #
See: newGetResourcePoliciesResponse
smart constructor.
Instances
newGetResourcePoliciesResponse Source #
Create a value of GetResourcePoliciesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetResourcePolicies
, getResourcePoliciesResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:GetResourcePoliciesResponse'
, getResourcePoliciesResponse_httpStatus
- The response's http status code.
$sel:resourcePolicies:GetResourcePoliciesResponse'
, getResourcePoliciesResponse_resourcePolicies
- Details about the resource policy attached to the response plan.
GetResponsePlan
data GetResponsePlan Source #
See: newGetResponsePlan
smart constructor.
Instances
Create a value of GetResponsePlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetResponsePlan
, getResponsePlan_arn
- The Amazon Resource Name (ARN) of the response plan.
data GetResponsePlanResponse Source #
See: newGetResponsePlanResponse
smart constructor.
GetResponsePlanResponse' (Maybe [Action]) (Maybe ChatChannel) (Maybe Text) (Maybe [Text]) (Maybe [Integration]) Int Text IncidentTemplate Text |
Instances
newGetResponsePlanResponse Source #
:: Int | |
-> Text | |
-> IncidentTemplate | |
-> Text | |
-> GetResponsePlanResponse |
Create a value of GetResponsePlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actions:GetResponsePlanResponse'
, getResponsePlanResponse_actions
- The actions that this response plan takes at the beginning of the
incident.
GetResponsePlanResponse
, getResponsePlanResponse_chatChannel
- The Chatbot chat channel used for collaboration during an incident.
GetResponsePlanResponse
, getResponsePlanResponse_displayName
- The long format name of the response plan. Can contain spaces.
$sel:engagements:GetResponsePlanResponse'
, getResponsePlanResponse_engagements
- The Amazon Resource Name (ARN) for the contacts and escalation plans
that the response plan engages during an incident.
$sel:integrations:GetResponsePlanResponse'
, getResponsePlanResponse_integrations
- Information about third-party services integrated into the Incident
Manager response plan.
$sel:httpStatus:GetResponsePlanResponse'
, getResponsePlanResponse_httpStatus
- The response's http status code.
GetResponsePlan
, getResponsePlanResponse_arn
- The ARN of the response plan.
$sel:incidentTemplate:GetResponsePlanResponse'
, getResponsePlanResponse_incidentTemplate
- Details used to create the incident when using this response plan.
GetResponsePlanResponse
, getResponsePlanResponse_name
- The short format name of the response plan. The name can't contain
spaces.
GetTimelineEvent
data GetTimelineEvent Source #
See: newGetTimelineEvent
smart constructor.
Instances
Create a value of GetTimelineEvent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTimelineEvent
, getTimelineEvent_eventId
- The ID of the event. You can get an event's ID when you create it, or
by using ListTimelineEvents
.
GetTimelineEvent
, getTimelineEvent_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident that includes the
timeline event.
data GetTimelineEventResponse Source #
See: newGetTimelineEventResponse
smart constructor.
Instances
newGetTimelineEventResponse Source #
Create a value of GetTimelineEventResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetTimelineEventResponse'
, getTimelineEventResponse_httpStatus
- The response's http status code.
$sel:event:GetTimelineEventResponse'
, getTimelineEventResponse_event
- Details about the timeline event.
ListIncidentRecords (Paginated)
data ListIncidentRecords Source #
See: newListIncidentRecords
smart constructor.
Instances
newListIncidentRecords :: ListIncidentRecords Source #
Create a value of ListIncidentRecords
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListIncidentRecords'
, listIncidentRecords_filters
- 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.
$sel:maxResults:ListIncidentRecords'
, listIncidentRecords_maxResults
- The maximum number of results per page.
ListIncidentRecords
, listIncidentRecords_nextToken
- The pagination token to continue to the next page of results.
data ListIncidentRecordsResponse Source #
See: newListIncidentRecordsResponse
smart constructor.
Instances
newListIncidentRecordsResponse Source #
Create a value of ListIncidentRecordsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListIncidentRecords
, listIncidentRecordsResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListIncidentRecordsResponse'
, listIncidentRecordsResponse_httpStatus
- The response's http status code.
$sel:incidentRecordSummaries:ListIncidentRecordsResponse'
, listIncidentRecordsResponse_incidentRecordSummaries
- The details of each listed incident record.
ListRelatedItems (Paginated)
data ListRelatedItems Source #
See: newListRelatedItems
smart constructor.
Instances
Create a value of ListRelatedItems
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListRelatedItems'
, listRelatedItems_maxResults
- The maximum number of related items per page.
ListRelatedItems
, listRelatedItems_nextToken
- The pagination token to continue to the next page of results.
ListRelatedItems
, listRelatedItems_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident record containing the
listed related items.
data ListRelatedItemsResponse Source #
See: newListRelatedItemsResponse
smart constructor.
Instances
newListRelatedItemsResponse Source #
Create a value of ListRelatedItemsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRelatedItems
, listRelatedItemsResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListRelatedItemsResponse'
, listRelatedItemsResponse_httpStatus
- The response's http status code.
$sel:relatedItems:ListRelatedItemsResponse'
, listRelatedItemsResponse_relatedItems
- Details about each related item.
ListReplicationSets (Paginated)
data ListReplicationSets Source #
See: newListReplicationSets
smart constructor.
Instances
newListReplicationSets :: ListReplicationSets Source #
Create a value of ListReplicationSets
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListReplicationSets'
, listReplicationSets_maxResults
- The maximum number of results per page.
ListReplicationSets
, listReplicationSets_nextToken
- The pagination token to continue to the next page of results.
data ListReplicationSetsResponse Source #
See: newListReplicationSetsResponse
smart constructor.
Instances
newListReplicationSetsResponse Source #
Create a value of ListReplicationSetsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListReplicationSets
, listReplicationSetsResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListReplicationSetsResponse'
, listReplicationSetsResponse_httpStatus
- The response's http status code.
$sel:replicationSetArns:ListReplicationSetsResponse'
, listReplicationSetsResponse_replicationSetArns
- The Amazon Resource Name (ARN) of the list replication set.
ListResponsePlans (Paginated)
data ListResponsePlans Source #
See: newListResponsePlans
smart constructor.
Instances
newListResponsePlans :: ListResponsePlans Source #
Create a value of ListResponsePlans
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResponsePlans'
, listResponsePlans_maxResults
- The maximum number of response plans per page.
ListResponsePlans
, listResponsePlans_nextToken
- The pagination token to continue to the next page of results.
data ListResponsePlansResponse Source #
See: newListResponsePlansResponse
smart constructor.
Instances
newListResponsePlansResponse Source #
Create a value of ListResponsePlansResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResponsePlans
, listResponsePlansResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListResponsePlansResponse'
, listResponsePlansResponse_httpStatus
- The response's http status code.
$sel:responsePlanSummaries:ListResponsePlansResponse'
, listResponsePlansResponse_responsePlanSummaries
- Details of each response plan.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) of the response plan.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A list of tags for the response plan.
ListTimelineEvents (Paginated)
data ListTimelineEvents Source #
See: newListTimelineEvents
smart constructor.
ListTimelineEvents' (Maybe [Filter]) (Maybe Natural) (Maybe Text) (Maybe TimelineEventSort) (Maybe SortOrder) Text |
Instances
newListTimelineEvents Source #
Create a value of ListTimelineEvents
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListTimelineEvents'
, listTimelineEvents_filters
- 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.
$sel:maxResults:ListTimelineEvents'
, listTimelineEvents_maxResults
- The maximum number of results per page.
ListTimelineEvents
, listTimelineEvents_nextToken
- The pagination token to continue to the next page of results.
$sel:sortBy:ListTimelineEvents'
, listTimelineEvents_sortBy
- Sort by the specified key value pair.
$sel:sortOrder:ListTimelineEvents'
, listTimelineEvents_sortOrder
- Sorts the order of timeline events by the value specified in the
sortBy
field.
ListTimelineEvents
, listTimelineEvents_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident that includes the
timeline event.
data ListTimelineEventsResponse Source #
See: newListTimelineEventsResponse
smart constructor.
Instances
newListTimelineEventsResponse Source #
Create a value of ListTimelineEventsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTimelineEvents
, listTimelineEventsResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListTimelineEventsResponse'
, listTimelineEventsResponse_httpStatus
- The response's http status code.
$sel:eventSummaries:ListTimelineEventsResponse'
, listTimelineEventsResponse_eventSummaries
- Details about each event that occurred during the incident.
PutResourcePolicy
data PutResourcePolicy Source #
See: newPutResourcePolicy
smart constructor.
Instances
Create a value of PutResourcePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:PutResourcePolicy'
, putResourcePolicy_policy
- Details of the resource policy.
PutResourcePolicy
, putResourcePolicy_resourceArn
- The Amazon Resource Name (ARN) of the response plan to add the resource
policy to.
data PutResourcePolicyResponse Source #
See: newPutResourcePolicyResponse
smart constructor.
Instances
newPutResourcePolicyResponse Source #
:: Int | |
-> Text | |
-> PutResourcePolicyResponse |
Create a value of PutResourcePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutResourcePolicyResponse'
, putResourcePolicyResponse_httpStatus
- The response's http status code.
PutResourcePolicyResponse
, putResourcePolicyResponse_policyId
- The ID of the resource policy.
StartIncident
data StartIncident Source #
See: newStartIncident
smart constructor.
StartIncident' (Maybe Text) (Maybe Natural) (Maybe [RelatedItem]) (Maybe Text) (Maybe TriggerDetails) Text |
Instances
Create a value of StartIncident
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:StartIncident'
, startIncident_clientToken
- A token ensuring that the operation is called only once with the
specified details.
StartIncident
, startIncident_impact
- 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.
$sel:relatedItems:StartIncident'
, startIncident_relatedItems
- 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
, startIncident_title
- Provide a title for the incident. Providing a title overwrites the title
provided by the response plan.
$sel:triggerDetails:StartIncident'
, startIncident_triggerDetails
- Details of what created the incident record in Incident Manager.
$sel:responsePlanArn:StartIncident'
, startIncident_responsePlanArn
- 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.
data StartIncidentResponse Source #
See: newStartIncidentResponse
smart constructor.
Instances
newStartIncidentResponse Source #
Create a value of StartIncidentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartIncidentResponse'
, startIncidentResponse_httpStatus
- The response's http status code.
StartIncidentResponse
, startIncidentResponse_incidentRecordArn
- The ARN of the newly created incident record.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagResource
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the response plan you're adding the
tags to.
$sel:tags:TagResource'
, tagResource_tags
- A list of tags to add to the response plan.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagResource
, untagResource_resourceArn
- The Amazon Resource Name (ARN) of the response plan you're removing a
tag from.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The name of the tag to remove from the response plan.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateDeletionProtection
data UpdateDeletionProtection Source #
See: newUpdateDeletionProtection
smart constructor.
Instances
newUpdateDeletionProtection Source #
Create a value of UpdateDeletionProtection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateDeletionProtection'
, updateDeletionProtection_clientToken
- A token that ensures that the operation is called only once with the
specified details.
UpdateDeletionProtection
, updateDeletionProtection_arn
- The Amazon Resource Name (ARN) of the replication set to update.
UpdateDeletionProtection
, updateDeletionProtection_deletionProtected
- Specifies if deletion protection is turned on or off in your account.
data UpdateDeletionProtectionResponse Source #
See: newUpdateDeletionProtectionResponse
smart constructor.
Instances
Generic UpdateDeletionProtectionResponse Source # | |
Read UpdateDeletionProtectionResponse Source # | |
Show UpdateDeletionProtectionResponse Source # | |
NFData UpdateDeletionProtectionResponse Source # | |
Defined in Amazonka.SSMIncidents.UpdateDeletionProtection rnf :: UpdateDeletionProtectionResponse -> () # | |
Eq UpdateDeletionProtectionResponse Source # | |
type Rep UpdateDeletionProtectionResponse Source # | |
Defined in Amazonka.SSMIncidents.UpdateDeletionProtection type Rep UpdateDeletionProtectionResponse = D1 ('MetaData "UpdateDeletionProtectionResponse" "Amazonka.SSMIncidents.UpdateDeletionProtection" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "UpdateDeletionProtectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateDeletionProtectionResponse Source #
Create a value of UpdateDeletionProtectionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDeletionProtectionResponse'
, updateDeletionProtectionResponse_httpStatus
- The response's http status code.
UpdateIncidentRecord
data UpdateIncidentRecord Source #
See: newUpdateIncidentRecord
smart constructor.
UpdateIncidentRecord' (Maybe ChatChannel) (Maybe Text) (Maybe Natural) (Maybe [NotificationTargetItem]) (Maybe IncidentRecordStatus) (Maybe Text) (Maybe Text) Text |
Instances
newUpdateIncidentRecord Source #
Create a value of UpdateIncidentRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateIncidentRecord
, updateIncidentRecord_chatChannel
- The Chatbot chat channel where responders can collaborate.
$sel:clientToken:UpdateIncidentRecord'
, updateIncidentRecord_clientToken
- A token that ensures that the operation is called only once with the
specified details.
UpdateIncidentRecord
, updateIncidentRecord_impact
- 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
, updateIncidentRecord_notificationTargets
- 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
, updateIncidentRecord_status
- The status of the incident. An incident can be Open
or Resolved
.
UpdateIncidentRecord
, updateIncidentRecord_summary
- A longer description of what occurred during the incident.
UpdateIncidentRecord
, updateIncidentRecord_title
- A brief description of the incident.
UpdateIncidentRecord
, updateIncidentRecord_arn
- The Amazon Resource Name (ARN) of the incident record you are updating.
data UpdateIncidentRecordResponse Source #
See: newUpdateIncidentRecordResponse
smart constructor.
Instances
newUpdateIncidentRecordResponse Source #
Create a value of UpdateIncidentRecordResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateIncidentRecordResponse'
, updateIncidentRecordResponse_httpStatus
- The response's http status code.
UpdateRelatedItems
data UpdateRelatedItems Source #
See: newUpdateRelatedItems
smart constructor.
Instances
newUpdateRelatedItems Source #
Create a value of UpdateRelatedItems
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateRelatedItems'
, updateRelatedItems_clientToken
- A token ensuring that the operation is called only once with the
specified details.
UpdateRelatedItems
, updateRelatedItems_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident record containing the
related items you are updating.
$sel:relatedItemsUpdate:UpdateRelatedItems'
, updateRelatedItems_relatedItemsUpdate
- Details about the item you are adding or deleting.
data UpdateRelatedItemsResponse Source #
See: newUpdateRelatedItemsResponse
smart constructor.
Instances
newUpdateRelatedItemsResponse Source #
Create a value of UpdateRelatedItemsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateRelatedItemsResponse'
, updateRelatedItemsResponse_httpStatus
- The response's http status code.
UpdateReplicationSet
data UpdateReplicationSet Source #
See: newUpdateReplicationSet
smart constructor.
Instances
newUpdateReplicationSet Source #
Create a value of UpdateReplicationSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateReplicationSet'
, updateReplicationSet_clientToken
- A token that ensures that the operation is called only once with the
specified details.
$sel:actions:UpdateReplicationSet'
, updateReplicationSet_actions
- An action to add or delete a Region.
UpdateReplicationSet
, updateReplicationSet_arn
- The Amazon Resource Name (ARN) of the replication set you're updating.
data UpdateReplicationSetResponse Source #
See: newUpdateReplicationSetResponse
smart constructor.
Instances
newUpdateReplicationSetResponse Source #
Create a value of UpdateReplicationSetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateReplicationSetResponse'
, updateReplicationSetResponse_httpStatus
- The response's http status code.
UpdateResponsePlan
data UpdateResponsePlan Source #
See: newUpdateResponsePlan
smart constructor.
UpdateResponsePlan' (Maybe [Action]) (Maybe ChatChannel) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Natural) (Maybe [NotificationTargetItem]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Integration]) Text |
Instances
newUpdateResponsePlan Source #
Create a value of UpdateResponsePlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actions:UpdateResponsePlan'
, updateResponsePlan_actions
- The actions that this response plan takes at the beginning of an
incident.
UpdateResponsePlan
, updateResponsePlan_chatChannel
- The Chatbot chat channel used for collaboration during an incident.
Use the empty structure to remove the chat channel from the response plan.
$sel:clientToken:UpdateResponsePlan'
, updateResponsePlan_clientToken
- A token ensuring that the operation is called only once with the
specified details.
UpdateResponsePlan
, updateResponsePlan_displayName
- The long format name of the response plan. The display name can't
contain spaces.
$sel:engagements:UpdateResponsePlan'
, updateResponsePlan_engagements
- The Amazon Resource Name (ARN) for the contacts and escalation plans
that the response plan engages during an incident.
$sel:incidentTemplateDedupeString:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateDedupeString
- The string Incident Manager uses to prevent duplicate incidents from
being created by the same incident in the same account.
$sel:incidentTemplateImpact:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateImpact
- 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
$sel:incidentTemplateNotificationTargets:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateNotificationTargets
- The Amazon SNS targets that are notified when updates are made to an
incident.
$sel:incidentTemplateSummary:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateSummary
- A brief summary of the incident. This typically contains what has
happened, what's currently happening, and next steps.
$sel:incidentTemplateTags:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateTags
- 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.
$sel:incidentTemplateTitle:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateTitle
- The short format name of the incident. The title can't contain spaces.
$sel:integrations:UpdateResponsePlan'
, updateResponsePlan_integrations
- Information about third-party services integrated into the response
plan.
UpdateResponsePlan
, updateResponsePlan_arn
- The Amazon Resource Name (ARN) of the response plan.
data UpdateResponsePlanResponse Source #
See: newUpdateResponsePlanResponse
smart constructor.
Instances
newUpdateResponsePlanResponse Source #
Create a value of UpdateResponsePlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateResponsePlanResponse'
, updateResponsePlanResponse_httpStatus
- The response's http status code.
UpdateTimelineEvent
data UpdateTimelineEvent Source #
See: newUpdateTimelineEvent
smart constructor.
UpdateTimelineEvent' (Maybe Text) (Maybe Text) (Maybe [EventReference]) (Maybe POSIX) (Maybe Text) Text Text |
Instances
newUpdateTimelineEvent Source #
Create a value of UpdateTimelineEvent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateTimelineEvent'
, updateTimelineEvent_clientToken
- A token ensuring that the operation is called only once with the
specified details.
UpdateTimelineEvent
, updateTimelineEvent_eventData
- A short description of the event.
UpdateTimelineEvent
, updateTimelineEvent_eventReferences
- 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
, updateTimelineEvent_eventTime
- The time that the event occurred.
UpdateTimelineEvent
, updateTimelineEvent_eventType
- The type of the event. You can update events of type Custom Event
.
UpdateTimelineEvent
, updateTimelineEvent_eventId
- The ID of the event you are updating. You can find this by using
ListTimelineEvents
.
UpdateTimelineEvent
, updateTimelineEvent_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident that includes the
timeline event.
data UpdateTimelineEventResponse Source #
See: newUpdateTimelineEventResponse
smart constructor.
Instances
newUpdateTimelineEventResponse Source #
Create a value of UpdateTimelineEventResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateTimelineEventResponse'
, updateTimelineEventResponse_httpStatus
- The response's http status code.
Types
IncidentRecordStatus
newtype IncidentRecordStatus Source #
pattern IncidentRecordStatus_OPEN :: IncidentRecordStatus | |
pattern IncidentRecordStatus_RESOLVED :: IncidentRecordStatus |
Instances
ItemType
pattern ItemType_ANALYSIS :: ItemType | |
pattern ItemType_ATTACHMENT :: ItemType | |
pattern ItemType_AUTOMATION :: ItemType | |
pattern ItemType_INCIDENT :: ItemType | |
pattern ItemType_INVOLVED_RESOURCE :: ItemType | |
pattern ItemType_METRIC :: ItemType | |
pattern ItemType_OTHER :: ItemType | |
pattern ItemType_PARENT :: ItemType | |
pattern ItemType_TASK :: ItemType |
Instances
RegionStatus
newtype RegionStatus Source #
pattern RegionStatus_ACTIVE :: RegionStatus | |
pattern RegionStatus_CREATING :: RegionStatus | |
pattern RegionStatus_DELETING :: RegionStatus | |
pattern RegionStatus_FAILED :: RegionStatus |
Instances
ReplicationSetStatus
newtype ReplicationSetStatus Source #
pattern ReplicationSetStatus_ACTIVE :: ReplicationSetStatus | |
pattern ReplicationSetStatus_CREATING :: ReplicationSetStatus | |
pattern ReplicationSetStatus_DELETING :: ReplicationSetStatus | |
pattern ReplicationSetStatus_FAILED :: ReplicationSetStatus | |
pattern ReplicationSetStatus_UPDATING :: ReplicationSetStatus |
Instances
SortOrder
pattern SortOrder_ASCENDING :: SortOrder | |
pattern SortOrder_DESCENDING :: SortOrder |
Instances
SsmTargetAccount
newtype SsmTargetAccount Source #
pattern SsmTargetAccount_IMPACTED_ACCOUNT :: SsmTargetAccount | |
pattern SsmTargetAccount_RESPONSE_PLAN_OWNER_ACCOUNT :: SsmTargetAccount |
Instances
TimelineEventSort
newtype TimelineEventSort Source #
pattern TimelineEventSort_EVENT_TIME :: TimelineEventSort |
Instances
VariableType
newtype VariableType Source #
pattern VariableType_INCIDENT_RECORD_ARN :: VariableType | |
pattern VariableType_INVOLVED_RESOURCES :: VariableType |
Instances
Action
The action that starts at the beginning of an incident. The response plan defines the action.
See: newAction
smart constructor.
Instances
FromJSON Action Source # | |
ToJSON Action Source # | |
Defined in Amazonka.SSMIncidents.Types.Action | |
Generic Action Source # | |
Read Action Source # | |
Show Action Source # | |
NFData Action Source # | |
Defined in Amazonka.SSMIncidents.Types.Action | |
Eq Action Source # | |
Hashable Action Source # | |
Defined in Amazonka.SSMIncidents.Types.Action | |
type Rep Action Source # | |
Defined in Amazonka.SSMIncidents.Types.Action type Rep Action = D1 ('MetaData "Action" "Amazonka.SSMIncidents.Types.Action" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "Action'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ssmAutomation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SsmAutomation)))) |
Create a value of Action
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ssmAutomation:Action'
, action_ssmAutomation
- The Systems Manager automation document to start as the runbook at the
beginning of the incident.
AddRegionAction
data AddRegionAction Source #
Defines the Amazon Web Services Region and KMS key to add to the replication set.
See: newAddRegionAction
smart constructor.
Instances
Create a value of AddRegionAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sseKmsKeyId:AddRegionAction'
, addRegionAction_sseKmsKeyId
- The KMS key ID to use to encrypt your replication set.
$sel:regionName:AddRegionAction'
, addRegionAction_regionName
- The Amazon Web Services Region name to add to the replication set.
AttributeValueList
data AttributeValueList Source #
Use the AttributeValueList to filter by string or integer values.
See: newAttributeValueList
smart constructor.
AttributeValueList' (Maybe [Int]) (Maybe [Text]) |
Instances
newAttributeValueList :: AttributeValueList Source #
Create a value of AttributeValueList
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:integerValues:AttributeValueList'
, attributeValueList_integerValues
- The list of integer values that the filter matches.
$sel:stringValues:AttributeValueList'
, attributeValueList_stringValues
- The list of string values that the filter matches.
AutomationExecution
data AutomationExecution Source #
The Systems Manager automation document process to start as the runbook at the beginning of the incident.
See: newAutomationExecution
smart constructor.
Instances
newAutomationExecution :: AutomationExecution Source #
Create a value of AutomationExecution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ssmExecutionArn:AutomationExecution'
, automationExecution_ssmExecutionArn
- The Amazon Resource Name (ARN) of the automation process.
ChatChannel
data ChatChannel Source #
The Chatbot chat channel used for collaboration during an incident.
See: newChatChannel
smart constructor.
Instances
newChatChannel :: ChatChannel Source #
Create a value of ChatChannel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:chatbotSns:ChatChannel'
, chatChannel_chatbotSns
- 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.
$sel:empty:ChatChannel'
, chatChannel_empty
- Used to remove the chat channel from an incident record or response
plan.
Condition
A conditional statement with which to compare a value, after a
timestamp, before a timestamp, or equal to a string or integer. If
multiple conditions are specified, the conditionals become an AND
ed
statement. If multiple values are specified for a conditional, the
values are OR
d.
See: newCondition
smart constructor.
Instances
ToJSON Condition Source # | |
Defined in Amazonka.SSMIncidents.Types.Condition | |
Generic Condition Source # | |
Read Condition Source # | |
Show Condition Source # | |
NFData Condition Source # | |
Defined in Amazonka.SSMIncidents.Types.Condition | |
Eq Condition Source # | |
Hashable Condition Source # | |
Defined in Amazonka.SSMIncidents.Types.Condition | |
type Rep Condition Source # | |
Defined in Amazonka.SSMIncidents.Types.Condition type Rep Condition = D1 ('MetaData "Condition" "Amazonka.SSMIncidents.Types.Condition" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "before") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "equals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValueList))))) |
newCondition :: Condition Source #
Create a value of Condition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:after:Condition'
, condition_after
- After the specified timestamp.
$sel:before:Condition'
, condition_before
- Before the specified timestamp
$sel:equals:Condition'
, condition_equals
- The value is equal to the provided string or integer.
DeleteRegionAction
data DeleteRegionAction Source #
Defines the information about the Amazon Web Services Region you're deleting from your replication set.
See: newDeleteRegionAction
smart constructor.
Instances
newDeleteRegionAction Source #
Create a value of DeleteRegionAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regionName:DeleteRegionAction'
, deleteRegionAction_regionName
- The name of the Amazon Web Services Region you're deleting from the
replication set.
DynamicSsmParameterValue
data DynamicSsmParameterValue Source #
The dynamic SSM parameter value.
See: newDynamicSsmParameterValue
smart constructor.
Instances
newDynamicSsmParameterValue :: DynamicSsmParameterValue Source #
Create a value of DynamicSsmParameterValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:variable:DynamicSsmParameterValue'
, dynamicSsmParameterValue_variable
- Variable dynamic parameters. A parameter value is determined when an
incident is created.
EmptyChatChannel
data EmptyChatChannel Source #
Used to remove the chat channel from an incident record or response plan.
See: newEmptyChatChannel
smart constructor.
Instances
newEmptyChatChannel :: EmptyChatChannel Source #
Create a value of EmptyChatChannel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
EventReference
data EventReference Source #
An item referenced in a TimelineEvent
that is involved in or somehow
associated with an incident. You can specify an Amazon Resource Name
(ARN) for an Amazon Web Services resource or a RelatedItem
ID.
See: newEventReference
smart constructor.
Instances
newEventReference :: EventReference Source #
Create a value of EventReference
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relatedItemId:EventReference'
, eventReference_relatedItemId
- The ID of a RelatedItem
referenced in a TimelineEvent
.
$sel:resource:EventReference'
, eventReference_resource
- The Amazon Resource Name (ARN) of an Amazon Web Services resource
referenced in a TimelineEvent
.
EventSummary
data EventSummary Source #
Details about a timeline event during an incident.
See: newEventSummary
smart constructor.
Instances
Create a value of EventSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventReferences:EventSummary'
, eventSummary_eventReferences
- A list of references in a TimelineEvent
.
$sel:eventId:EventSummary'
, eventSummary_eventId
- The timeline event ID.
$sel:eventTime:EventSummary'
, eventSummary_eventTime
- The time that the event occurred.
$sel:eventType:EventSummary'
, eventSummary_eventType
- The type of event. The timeline event must be Custom Event
.
$sel:eventUpdatedTime:EventSummary'
, eventSummary_eventUpdatedTime
- The time that the timeline event was last updated.
$sel:incidentRecordArn:EventSummary'
, eventSummary_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident that the event happened
during.
Filter
Filter the selection by using a condition.
See: newFilter
smart constructor.
Instances
ToJSON Filter Source # | |
Defined in Amazonka.SSMIncidents.Types.Filter | |
Generic Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.SSMIncidents.Types.Filter | |
Eq Filter Source # | |
Hashable Filter Source # | |
Defined in Amazonka.SSMIncidents.Types.Filter | |
type Rep Filter Source # | |
Defined in Amazonka.SSMIncidents.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.SSMIncidents.Types.Filter" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Condition) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Filter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:condition:Filter'
, filter_condition
- The condition accepts before or after a specified time, equal to a
string, or equal to an integer.
$sel:key:Filter'
, filter_key
- The key that you're filtering on.
IncidentRecord
data IncidentRecord Source #
The record of the incident that's created when an incident occurs.
See: newIncidentRecord
smart constructor.
Instances
:: Text | |
-> UTCTime | |
-> Text | |
-> Natural | |
-> IncidentRecordSource | |
-> Text | |
-> UTCTime | |
-> IncidentRecordStatus | |
-> Text | |
-> IncidentRecord |
Create a value of IncidentRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automationExecutions:IncidentRecord'
, incidentRecord_automationExecutions
- The runbook, or automation document, that's run at the beginning of the
incident.
$sel:chatChannel:IncidentRecord'
, incidentRecord_chatChannel
- The chat channel used for collaboration during an incident.
$sel:notificationTargets:IncidentRecord'
, incidentRecord_notificationTargets
- The Amazon SNS targets that are notified when updates are made to an
incident.
$sel:resolvedTime:IncidentRecord'
, incidentRecord_resolvedTime
- The time at which the incident was resolved. This appears as a timeline
event.
$sel:summary:IncidentRecord'
, incidentRecord_summary
- The summary of the incident. The summary is a brief synopsis of what
occurred, what's currently happening, and context of the incident.
$sel:arn:IncidentRecord'
, incidentRecord_arn
- The Amazon Resource Name (ARN) of the incident record.
$sel:creationTime:IncidentRecord'
, incidentRecord_creationTime
- The time that Incident Manager created the incident record.
$sel:dedupeString:IncidentRecord'
, incidentRecord_dedupeString
- The string Incident Manager uses to prevent duplicate incidents from
being created by the same incident in the same account.
$sel:impact:IncidentRecord'
, incidentRecord_impact
- The impact of the incident on customers and applications.
$sel:incidentRecordSource:IncidentRecord'
, incidentRecord_incidentRecordSource
- Details about the action that started the incident.
$sel:lastModifiedBy:IncidentRecord'
, incidentRecord_lastModifiedBy
- Who modified the incident most recently.
$sel:lastModifiedTime:IncidentRecord'
, incidentRecord_lastModifiedTime
- The time at which the incident was most recently modified.
$sel:status:IncidentRecord'
, incidentRecord_status
- The current status of the incident.
$sel:title:IncidentRecord'
, incidentRecord_title
- The title of the incident.
IncidentRecordSource
data IncidentRecordSource Source #
Details about what created the incident record and when it was created.
See: newIncidentRecordSource
smart constructor.
Instances
newIncidentRecordSource Source #
:: Text | |
-> Text | |
-> IncidentRecordSource |
Create a value of IncidentRecordSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:invokedBy:IncidentRecordSource'
, incidentRecordSource_invokedBy
- The service principal that assumed the role specified in createdBy
. If
no service principal assumed the role this will be left blank.
$sel:resourceArn:IncidentRecordSource'
, incidentRecordSource_resourceArn
- The resource that caused the incident to be created.
$sel:createdBy:IncidentRecordSource'
, incidentRecordSource_createdBy
- The principal that started the incident.
$sel:source:IncidentRecordSource'
, incidentRecordSource_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
data IncidentRecordSummary Source #
Details describing an incident record.
See: newIncidentRecordSummary
smart constructor.
IncidentRecordSummary' (Maybe POSIX) Text POSIX Natural IncidentRecordSource IncidentRecordStatus Text |
Instances
newIncidentRecordSummary Source #
:: Text | |
-> UTCTime | |
-> Natural | |
-> IncidentRecordSource | |
-> IncidentRecordStatus | |
-> Text | |
-> IncidentRecordSummary |
Create a value of IncidentRecordSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resolvedTime:IncidentRecordSummary'
, incidentRecordSummary_resolvedTime
- The time the incident was resolved.
$sel:arn:IncidentRecordSummary'
, incidentRecordSummary_arn
- The Amazon Resource Name (ARN) of the incident.
$sel:creationTime:IncidentRecordSummary'
, incidentRecordSummary_creationTime
- The time the incident was created.
$sel:impact:IncidentRecordSummary'
, incidentRecordSummary_impact
- Defines the impact to customers and applications.
$sel:incidentRecordSource:IncidentRecordSummary'
, incidentRecordSummary_incidentRecordSource
- What caused Incident Manager to create the incident.
$sel:status:IncidentRecordSummary'
, incidentRecordSummary_status
- The current status of the incident.
$sel:title:IncidentRecordSummary'
, incidentRecordSummary_title
- The title of the incident. This value is either provided by the response
plan or overwritten on creation.
IncidentTemplate
data IncidentTemplate Source #
Basic details used in creating a response plan. The response plan is then used to create an incident record.
See: newIncidentTemplate
smart constructor.
IncidentTemplate' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [NotificationTargetItem]) (Maybe Text) Natural Text |
Instances
Create a value of IncidentTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dedupeString:IncidentTemplate'
, incidentTemplate_dedupeString
- Used to stop Incident Manager from creating multiple incident records
for the same incident.
$sel:incidentTags:IncidentTemplate'
, incidentTemplate_incidentTags
- 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.
$sel:notificationTargets:IncidentTemplate'
, incidentTemplate_notificationTargets
- The Amazon SNS targets that are notified when updates are made to an
incident.
$sel:summary:IncidentTemplate'
, incidentTemplate_summary
- The summary of the incident. The summary is a brief synopsis of what
occurred, what's currently happening, and context.
$sel:impact:IncidentTemplate'
, incidentTemplate_impact
- The impact of the incident on your customers and applications.
$sel:title:IncidentTemplate'
, incidentTemplate_title
- The title of the incident.
Integration
data Integration Source #
Information about third-party services integrated into a response plan.
See: newIntegration
smart constructor.
Instances
newIntegration :: Integration Source #
Create a value of Integration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pagerDutyConfiguration:Integration'
, integration_pagerDutyConfiguration
- Information about the PagerDuty service where the response plan creates
an incident.
ItemIdentifier
data ItemIdentifier Source #
Details and type of a related item.
See: newItemIdentifier
smart constructor.
Instances
Create a value of ItemIdentifier
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':ItemIdentifier'
, itemIdentifier_type
- The type of related item.
$sel:value:ItemIdentifier'
, itemIdentifier_value
- Details about the related item.
ItemValue
Describes a related item.
See: newItemValue
smart constructor.
Instances
newItemValue :: ItemValue Source #
Create a value of ItemValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ItemValue'
, itemValue_arn
- The Amazon Resource Name (ARN) of the related item, if the related item
is an Amazon resource.
$sel:metricDefinition:ItemValue'
, itemValue_metricDefinition
- The metric definition, if the related item is a metric in Amazon
CloudWatch.
$sel:pagerDutyIncidentDetail:ItemValue'
, itemValue_pagerDutyIncidentDetail
- Details about an incident that is associated with a PagerDuty incident.
$sel:url:ItemValue'
, itemValue_url
- The URL, if the related item is a non-Amazon Web Services resource.
NotificationTargetItem
data NotificationTargetItem Source #
The SNS targets that are notified when updates are made to an incident.
See: newNotificationTargetItem
smart constructor.
Instances
newNotificationTargetItem :: NotificationTargetItem Source #
Create a value of NotificationTargetItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snsTopicArn:NotificationTargetItem'
, notificationTargetItem_snsTopicArn
- The Amazon Resource Name (ARN) of the SNS topic.
PagerDutyConfiguration
data PagerDutyConfiguration Source #
Details about the PagerDuty configuration for a response plan.
See: newPagerDutyConfiguration
smart constructor.
Instances
newPagerDutyConfiguration Source #
Create a value of PagerDutyConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:PagerDutyConfiguration'
, pagerDutyConfiguration_name
- The name of the PagerDuty configuration.
$sel:pagerDutyIncidentConfiguration:PagerDutyConfiguration'
, pagerDutyConfiguration_pagerDutyIncidentConfiguration
- Details about the PagerDuty service associated with the configuration.
$sel:secretId:PagerDutyConfiguration'
, pagerDutyConfiguration_secretId
- 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
data PagerDutyIncidentConfiguration Source #
Details about the PagerDuty service where the response plan creates an incident.
See: newPagerDutyIncidentConfiguration
smart constructor.
Instances
FromJSON PagerDutyIncidentConfiguration Source # | |
ToJSON PagerDutyIncidentConfiguration Source # | |
Generic PagerDutyIncidentConfiguration Source # | |
Read PagerDutyIncidentConfiguration Source # | |
Show PagerDutyIncidentConfiguration Source # | |
NFData PagerDutyIncidentConfiguration Source # | |
Defined in Amazonka.SSMIncidents.Types.PagerDutyIncidentConfiguration rnf :: PagerDutyIncidentConfiguration -> () # | |
Eq PagerDutyIncidentConfiguration Source # | |
Hashable PagerDutyIncidentConfiguration Source # | |
type Rep PagerDutyIncidentConfiguration Source # | |
Defined in Amazonka.SSMIncidents.Types.PagerDutyIncidentConfiguration type Rep PagerDutyIncidentConfiguration = D1 ('MetaData "PagerDutyIncidentConfiguration" "Amazonka.SSMIncidents.Types.PagerDutyIncidentConfiguration" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "PagerDutyIncidentConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newPagerDutyIncidentConfiguration Source #
Create a value of PagerDutyIncidentConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceId:PagerDutyIncidentConfiguration'
, pagerDutyIncidentConfiguration_serviceId
- The ID of the PagerDuty service that the response plan associates with
an incident when it launches.
PagerDutyIncidentDetail
data PagerDutyIncidentDetail Source #
Details about the PagerDuty incident associated with an incident created by an Incident Manager response plan.
See: newPagerDutyIncidentDetail
smart constructor.
Instances
newPagerDutyIncidentDetail Source #
Create a value of PagerDutyIncidentDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoResolve:PagerDutyIncidentDetail'
, pagerDutyIncidentDetail_autoResolve
- Indicates whether to resolve the PagerDuty incident when you resolve the
associated Incident Manager incident.
$sel:secretId:PagerDutyIncidentDetail'
, pagerDutyIncidentDetail_secretId
- 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.
$sel:id:PagerDutyIncidentDetail'
, pagerDutyIncidentDetail_id
- The ID of the incident associated with the PagerDuty service for the
response plan.
RegionInfo
data RegionInfo Source #
Information about a Amazon Web Services Region in your replication set.
See: newRegionInfo
smart constructor.
Instances
Create a value of RegionInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sseKmsKeyId:RegionInfo'
, regionInfo_sseKmsKeyId
- The ID of the KMS key used to encrypt the data in this Amazon Web
Services Region.
$sel:statusMessage:RegionInfo'
, regionInfo_statusMessage
- Information displayed about the status of the Amazon Web Services
Region.
$sel:status:RegionInfo'
, regionInfo_status
- The status of the Amazon Web Services Region in the replication set.
$sel:statusUpdateDateTime:RegionInfo'
, regionInfo_statusUpdateDateTime
- The most recent date and time that Incident Manager updated the Amazon
Web Services Region's status.
RegionMapInputValue
data RegionMapInputValue Source #
The mapping between a Amazon Web Services Region and the key that's used to encrypt the data.
See: newRegionMapInputValue
smart constructor.
Instances
newRegionMapInputValue :: RegionMapInputValue Source #
Create a value of RegionMapInputValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sseKmsKeyId:RegionMapInputValue'
, regionMapInputValue_sseKmsKeyId
- The KMS key used to encrypt the data in your replication set.
RelatedItem
data RelatedItem Source #
Resources that responders use to triage and mitigate the incident.
See: newRelatedItem
smart constructor.
Instances
Create a value of RelatedItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:generatedId:RelatedItem'
, relatedItem_generatedId
- A unique ID for a RelatedItem
.
Don't specify this parameter when you add a RelatedItem
by using the
UpdateRelatedItems API action.
$sel:title:RelatedItem'
, relatedItem_title
- The title of the related item.
$sel:identifier:RelatedItem'
, relatedItem_identifier
- Details about the related item.
RelatedItemsUpdate
data RelatedItemsUpdate Source #
Details about the related item you're adding.
See: newRelatedItemsUpdate
smart constructor.
Instances
newRelatedItemsUpdate :: RelatedItemsUpdate Source #
Create a value of RelatedItemsUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:itemToAdd:RelatedItemsUpdate'
, relatedItemsUpdate_itemToAdd
- Details about the related item you're adding.
$sel:itemToRemove:RelatedItemsUpdate'
, relatedItemsUpdate_itemToRemove
- Details about the related item you're deleting.
ReplicationSet
data ReplicationSet Source #
The set of Amazon Web Services Region that your Incident Manager data will be replicated to and the KMS key used to encrypt the data.
See: newReplicationSet
smart constructor.
ReplicationSet' (Maybe Text) Text POSIX Bool Text POSIX (HashMap Text RegionInfo) ReplicationSetStatus |
Instances
:: Text | |
-> UTCTime | |
-> Bool | |
-> Text | |
-> UTCTime | |
-> ReplicationSetStatus | |
-> ReplicationSet |
Create a value of ReplicationSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ReplicationSet'
, replicationSet_arn
- The Amazon Resource Name (ARN) of the replication set.
$sel:createdBy:ReplicationSet'
, replicationSet_createdBy
- Details about who created the replication set.
$sel:createdTime:ReplicationSet'
, replicationSet_createdTime
- When the replication set was created.
$sel:deletionProtected:ReplicationSet'
, replicationSet_deletionProtected
- 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.
$sel:lastModifiedBy:ReplicationSet'
, replicationSet_lastModifiedBy
- Who last modified the replication set.
$sel:lastModifiedTime:ReplicationSet'
, replicationSet_lastModifiedTime
- When the replication set was last updated.
$sel:regionMap:ReplicationSet'
, replicationSet_regionMap
- 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
, replicationSet_status
- The status of the replication set. If the replication set is still
pending, you can't use Incident Manager functionality.
ResourcePolicy
data ResourcePolicy Source #
The resource policy that allows Incident Manager to perform actions on resources on your behalf.
See: newResourcePolicy
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> ResourcePolicy |
Create a value of ResourcePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyDocument:ResourcePolicy'
, resourcePolicy_policyDocument
- The JSON blob that describes the policy.
$sel:policyId:ResourcePolicy'
, resourcePolicy_policyId
- The ID of the resource policy.
$sel:ramResourceShareRegion:ResourcePolicy'
, resourcePolicy_ramResourceShareRegion
- The Amazon Web Services Region that policy allows resources to be used
in.
ResponsePlanSummary
data ResponsePlanSummary Source #
Details of the response plan that are used when creating an incident.
See: newResponsePlanSummary
smart constructor.
Instances
newResponsePlanSummary Source #
Create a value of ResponsePlanSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:displayName:ResponsePlanSummary'
, responsePlanSummary_displayName
- The human readable name of the response plan. This can include spaces.
$sel:arn:ResponsePlanSummary'
, responsePlanSummary_arn
- The Amazon Resource Name (ARN) of the response plan.
$sel:name:ResponsePlanSummary'
, responsePlanSummary_name
- The name of the response plan. This can't include spaces.
SsmAutomation
data SsmAutomation Source #
Details about the Systems Manager automation document that will be used as a runbook during an incident.
See: newSsmAutomation
smart constructor.
SsmAutomation' (Maybe Text) (Maybe (HashMap Text DynamicSsmParameterValue)) (Maybe (HashMap Text [Text])) (Maybe SsmTargetAccount) Text Text |
Instances
Create a value of SsmAutomation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentVersion:SsmAutomation'
, ssmAutomation_documentVersion
- The automation document's version to use when running.
$sel:dynamicParameters:SsmAutomation'
, ssmAutomation_dynamicParameters
- The key-value pair to resolve dynamic parameter values when processing a
Systems Manager Automation runbook.
$sel:parameters:SsmAutomation'
, ssmAutomation_parameters
- The key-value pair parameters to use when running the automation
document.
$sel:targetAccount:SsmAutomation'
, ssmAutomation_targetAccount
- The account that the automation document will be run in. This can be in
either the management account or an application account.
$sel:documentName:SsmAutomation'
, ssmAutomation_documentName
- The automation document's name.
$sel:roleArn:SsmAutomation'
, ssmAutomation_roleArn
- The Amazon Resource Name (ARN) of the role that the automation document
will assume when running commands.
TimelineEvent
data TimelineEvent Source #
A significant event that happened during the incident.
See: newTimelineEvent
smart constructor.
Instances
Create a value of TimelineEvent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventReferences:TimelineEvent'
, timelineEvent_eventReferences
- A list of references in a TimelineEvent
.
$sel:eventData:TimelineEvent'
, timelineEvent_eventData
- A short description of the event.
$sel:eventId:TimelineEvent'
, timelineEvent_eventId
- The ID of the timeline event.
$sel:eventTime:TimelineEvent'
, timelineEvent_eventTime
- The time that the event occurred.
$sel:eventType:TimelineEvent'
, timelineEvent_eventType
- The type of event that occurred. Currently Incident Manager supports
only the Custom Event
type.
$sel:eventUpdatedTime:TimelineEvent'
, timelineEvent_eventUpdatedTime
- The time that the timeline event was last updated.
$sel:incidentRecordArn:TimelineEvent'
, timelineEvent_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident that the event occurred
during.
TriggerDetails
data TriggerDetails Source #
Details about what caused the incident to be created in Incident Manager.
See: newTriggerDetails
smart constructor.
Instances
Create a value of TriggerDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rawData:TriggerDetails'
, triggerDetails_rawData
- Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or
Incident Manager when an incident is created.
$sel:triggerArn:TriggerDetails'
, triggerDetails_triggerArn
- The Amazon Resource Name (ARN) of the source that detected the incident.
$sel:source:TriggerDetails'
, triggerDetails_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.
$sel:timestamp:TriggerDetails'
, triggerDetails_timestamp
- The time that the incident was detected.
UpdateReplicationSetAction
data UpdateReplicationSetAction Source #
Details used when updating the replication set.
See: newUpdateReplicationSetAction
smart constructor.
Instances
newUpdateReplicationSetAction :: UpdateReplicationSetAction Source #
Create a value of UpdateReplicationSetAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addRegionAction:UpdateReplicationSetAction'
, updateReplicationSetAction_addRegionAction
- Details about the Amazon Web Services Region that you're adding to the
replication set.
$sel:deleteRegionAction:UpdateReplicationSetAction'
, updateReplicationSetAction_deleteRegionAction
- Details about the Amazon Web Services Region that you're deleting to
the replication set.