| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SSMIncidents.Types
Contents
- Service Configuration
- Errors
- IncidentRecordStatus
- ItemType
- RegionStatus
- ReplicationSetStatus
- SortOrder
- SsmTargetAccount
- TimelineEventSort
- Action
- AddRegionAction
- AttributeValueList
- AutomationExecution
- ChatChannel
- Condition
- DeleteRegionAction
- EmptyChatChannel
- EventSummary
- Filter
- IncidentRecord
- IncidentRecordSource
- IncidentRecordSummary
- IncidentTemplate
- ItemIdentifier
- ItemValue
- NotificationTargetItem
- RegionInfo
- RegionMapInputValue
- RelatedItem
- RelatedItemsUpdate
- ReplicationSet
- ResourcePolicy
- ResponsePlanSummary
- SsmAutomation
- TimelineEvent
- TriggerDetails
- UpdateReplicationSetAction
Description
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype IncidentRecordStatus where
- newtype ItemType where
- ItemType' {
- fromItemType :: Text
- pattern ItemType_ANALYSIS :: ItemType
- pattern ItemType_ATTACHMENT :: ItemType
- pattern ItemType_INCIDENT :: ItemType
- pattern ItemType_METRIC :: ItemType
- pattern ItemType_OTHER :: ItemType
- pattern ItemType_PARENT :: 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
- data Action = Action' {}
- newAction :: Action
- action_ssmAutomation :: Lens' Action (Maybe SsmAutomation)
- data AddRegionAction = AddRegionAction' {
- sseKmsKeyId :: Maybe Text
- regionName :: Text
- newAddRegionAction :: Text -> AddRegionAction
- addRegionAction_sseKmsKeyId :: Lens' AddRegionAction (Maybe Text)
- addRegionAction_regionName :: Lens' AddRegionAction Text
- data AttributeValueList = AttributeValueList' {
- stringValues :: Maybe [Text]
- integerValues :: Maybe [Int]
- newAttributeValueList :: AttributeValueList
- attributeValueList_stringValues :: Lens' AttributeValueList (Maybe [Text])
- attributeValueList_integerValues :: Lens' AttributeValueList (Maybe [Int])
- data AutomationExecution = AutomationExecution' {}
- newAutomationExecution :: AutomationExecution
- automationExecution_ssmExecutionArn :: Lens' AutomationExecution (Maybe Text)
- data ChatChannel = ChatChannel' {}
- newChatChannel :: ChatChannel
- chatChannel_empty :: Lens' ChatChannel (Maybe EmptyChatChannel)
- chatChannel_chatbotSns :: Lens' ChatChannel (Maybe (NonEmpty Text))
- data Condition = Condition' {}
- newCondition :: Condition
- condition_after :: Lens' Condition (Maybe UTCTime)
- condition_equals :: Lens' Condition (Maybe AttributeValueList)
- condition_before :: Lens' Condition (Maybe UTCTime)
- data DeleteRegionAction = DeleteRegionAction' {
- regionName :: Text
- newDeleteRegionAction :: Text -> DeleteRegionAction
- deleteRegionAction_regionName :: Lens' DeleteRegionAction Text
- data EmptyChatChannel = EmptyChatChannel' {
- newEmptyChatChannel :: EmptyChatChannel
- data EventSummary = EventSummary' {
- eventId :: Text
- eventTime :: POSIX
- eventType :: Text
- eventUpdatedTime :: POSIX
- incidentRecordArn :: Text
- newEventSummary :: Text -> UTCTime -> Text -> UTCTime -> Text -> EventSummary
- eventSummary_eventId :: Lens' EventSummary Text
- eventSummary_eventTime :: Lens' EventSummary UTCTime
- eventSummary_eventType :: Lens' EventSummary Text
- eventSummary_eventUpdatedTime :: Lens' EventSummary UTCTime
- eventSummary_incidentRecordArn :: Lens' EventSummary Text
- data Filter = Filter' {}
- newFilter :: Condition -> Text -> Filter
- filter_condition :: Lens' Filter Condition
- filter_key :: Lens' Filter Text
- data IncidentRecord = IncidentRecord' {
- summary :: Maybe Text
- notificationTargets :: Maybe [NotificationTargetItem]
- resolvedTime :: Maybe POSIX
- chatChannel :: Maybe ChatChannel
- automationExecutions :: Maybe [AutomationExecution]
- arn :: Text
- creationTime :: POSIX
- dedupeString :: Text
- impact :: Natural
- incidentRecordSource :: IncidentRecordSource
- lastModifiedBy :: Text
- lastModifiedTime :: POSIX
- status :: IncidentRecordStatus
- title :: Text
- newIncidentRecord :: Text -> UTCTime -> Text -> Natural -> IncidentRecordSource -> Text -> UTCTime -> IncidentRecordStatus -> Text -> IncidentRecord
- incidentRecord_summary :: Lens' IncidentRecord (Maybe Text)
- incidentRecord_notificationTargets :: Lens' IncidentRecord (Maybe [NotificationTargetItem])
- incidentRecord_resolvedTime :: Lens' IncidentRecord (Maybe UTCTime)
- incidentRecord_chatChannel :: Lens' IncidentRecord (Maybe ChatChannel)
- incidentRecord_automationExecutions :: Lens' IncidentRecord (Maybe [AutomationExecution])
- incidentRecord_arn :: Lens' IncidentRecord Text
- incidentRecord_creationTime :: Lens' IncidentRecord UTCTime
- incidentRecord_dedupeString :: Lens' IncidentRecord Text
- incidentRecord_impact :: Lens' IncidentRecord Natural
- incidentRecord_incidentRecordSource :: Lens' IncidentRecord IncidentRecordSource
- incidentRecord_lastModifiedBy :: Lens' IncidentRecord Text
- incidentRecord_lastModifiedTime :: Lens' IncidentRecord UTCTime
- incidentRecord_status :: Lens' IncidentRecord IncidentRecordStatus
- incidentRecord_title :: Lens' IncidentRecord Text
- data IncidentRecordSource = IncidentRecordSource' {}
- newIncidentRecordSource :: Text -> Text -> IncidentRecordSource
- incidentRecordSource_invokedBy :: Lens' IncidentRecordSource (Maybe Text)
- incidentRecordSource_resourceArn :: Lens' IncidentRecordSource (Maybe Text)
- incidentRecordSource_createdBy :: Lens' IncidentRecordSource Text
- incidentRecordSource_source :: Lens' IncidentRecordSource Text
- data IncidentRecordSummary = IncidentRecordSummary' {}
- newIncidentRecordSummary :: Text -> UTCTime -> Natural -> IncidentRecordSource -> IncidentRecordStatus -> Text -> IncidentRecordSummary
- incidentRecordSummary_resolvedTime :: Lens' IncidentRecordSummary (Maybe UTCTime)
- incidentRecordSummary_arn :: Lens' IncidentRecordSummary Text
- incidentRecordSummary_creationTime :: Lens' IncidentRecordSummary UTCTime
- incidentRecordSummary_impact :: Lens' IncidentRecordSummary Natural
- incidentRecordSummary_incidentRecordSource :: Lens' IncidentRecordSummary IncidentRecordSource
- incidentRecordSummary_status :: Lens' IncidentRecordSummary IncidentRecordStatus
- incidentRecordSummary_title :: Lens' IncidentRecordSummary Text
- data IncidentTemplate = IncidentTemplate' {}
- newIncidentTemplate :: Natural -> Text -> IncidentTemplate
- incidentTemplate_summary :: Lens' IncidentTemplate (Maybe Text)
- incidentTemplate_notificationTargets :: Lens' IncidentTemplate (Maybe [NotificationTargetItem])
- incidentTemplate_dedupeString :: Lens' IncidentTemplate (Maybe Text)
- incidentTemplate_impact :: Lens' IncidentTemplate Natural
- incidentTemplate_title :: Lens' IncidentTemplate Text
- data ItemIdentifier = ItemIdentifier' {}
- newItemIdentifier :: ItemType -> ItemValue -> ItemIdentifier
- itemIdentifier_type :: Lens' ItemIdentifier ItemType
- itemIdentifier_value :: Lens' ItemIdentifier ItemValue
- data ItemValue = ItemValue' {}
- newItemValue :: ItemValue
- itemValue_arn :: Lens' ItemValue (Maybe Text)
- itemValue_url :: Lens' ItemValue (Maybe Text)
- itemValue_metricDefinition :: Lens' ItemValue (Maybe Text)
- data NotificationTargetItem = NotificationTargetItem' {
- snsTopicArn :: Maybe Text
- newNotificationTargetItem :: NotificationTargetItem
- notificationTargetItem_snsTopicArn :: Lens' NotificationTargetItem (Maybe Text)
- data RegionInfo = RegionInfo' {}
- newRegionInfo :: RegionStatus -> UTCTime -> RegionInfo
- regionInfo_statusMessage :: Lens' RegionInfo (Maybe Text)
- regionInfo_sseKmsKeyId :: Lens' RegionInfo (Maybe Text)
- regionInfo_status :: Lens' RegionInfo RegionStatus
- regionInfo_statusUpdateDateTime :: Lens' RegionInfo UTCTime
- data RegionMapInputValue = RegionMapInputValue' {
- sseKmsKeyId :: Maybe Text
- newRegionMapInputValue :: RegionMapInputValue
- regionMapInputValue_sseKmsKeyId :: Lens' RegionMapInputValue (Maybe Text)
- data RelatedItem = RelatedItem' {}
- newRelatedItem :: ItemIdentifier -> RelatedItem
- relatedItem_title :: Lens' RelatedItem (Maybe Text)
- relatedItem_identifier :: Lens' RelatedItem ItemIdentifier
- data RelatedItemsUpdate = RelatedItemsUpdate' {}
- newRelatedItemsUpdate :: RelatedItemsUpdate
- relatedItemsUpdate_itemToRemove :: Lens' RelatedItemsUpdate (Maybe ItemIdentifier)
- relatedItemsUpdate_itemToAdd :: Lens' RelatedItemsUpdate (Maybe RelatedItem)
- data ReplicationSet = ReplicationSet' {}
- newReplicationSet :: Text -> UTCTime -> Bool -> Text -> UTCTime -> ReplicationSetStatus -> ReplicationSet
- replicationSet_arn :: Lens' ReplicationSet (Maybe Text)
- replicationSet_createdBy :: Lens' ReplicationSet Text
- replicationSet_createdTime :: Lens' ReplicationSet UTCTime
- replicationSet_deletionProtected :: Lens' ReplicationSet Bool
- replicationSet_lastModifiedBy :: Lens' ReplicationSet Text
- replicationSet_lastModifiedTime :: Lens' ReplicationSet UTCTime
- replicationSet_regionMap :: Lens' ReplicationSet (HashMap Text RegionInfo)
- replicationSet_status :: Lens' ReplicationSet ReplicationSetStatus
- data ResourcePolicy = ResourcePolicy' {}
- newResourcePolicy :: Text -> Text -> Text -> ResourcePolicy
- resourcePolicy_policyDocument :: Lens' ResourcePolicy Text
- resourcePolicy_policyId :: Lens' ResourcePolicy Text
- resourcePolicy_ramResourceShareRegion :: Lens' ResourcePolicy Text
- data ResponsePlanSummary = ResponsePlanSummary' {}
- newResponsePlanSummary :: Text -> Text -> ResponsePlanSummary
- responsePlanSummary_displayName :: Lens' ResponsePlanSummary (Maybe Text)
- responsePlanSummary_arn :: Lens' ResponsePlanSummary Text
- responsePlanSummary_name :: Lens' ResponsePlanSummary Text
- data SsmAutomation = SsmAutomation' {
- targetAccount :: Maybe SsmTargetAccount
- parameters :: Maybe (HashMap Text [Text])
- documentVersion :: Maybe Text
- documentName :: Text
- roleArn :: Text
- newSsmAutomation :: Text -> Text -> SsmAutomation
- ssmAutomation_targetAccount :: Lens' SsmAutomation (Maybe SsmTargetAccount)
- ssmAutomation_parameters :: Lens' SsmAutomation (Maybe (HashMap Text [Text]))
- ssmAutomation_documentVersion :: Lens' SsmAutomation (Maybe Text)
- ssmAutomation_documentName :: Lens' SsmAutomation Text
- ssmAutomation_roleArn :: Lens' SsmAutomation Text
- data TimelineEvent = TimelineEvent' {}
- newTimelineEvent :: Text -> Text -> UTCTime -> Text -> UTCTime -> Text -> TimelineEvent
- timelineEvent_eventData :: Lens' TimelineEvent Text
- timelineEvent_eventId :: Lens' TimelineEvent Text
- timelineEvent_eventTime :: Lens' TimelineEvent UTCTime
- timelineEvent_eventType :: Lens' TimelineEvent Text
- timelineEvent_eventUpdatedTime :: Lens' TimelineEvent UTCTime
- timelineEvent_incidentRecordArn :: Lens' TimelineEvent Text
- data TriggerDetails = TriggerDetails' {}
- newTriggerDetails :: Text -> UTCTime -> TriggerDetails
- triggerDetails_rawData :: Lens' TriggerDetails (Maybe Text)
- triggerDetails_triggerArn :: Lens' TriggerDetails (Maybe Text)
- triggerDetails_source :: Lens' TriggerDetails Text
- triggerDetails_timestamp :: Lens' TriggerDetails UTCTime
- data UpdateReplicationSetAction = UpdateReplicationSetAction' {}
- newUpdateReplicationSetAction :: UpdateReplicationSetAction
- updateReplicationSetAction_addRegionAction :: Lens' UpdateReplicationSetAction (Maybe AddRegionAction)
- updateReplicationSetAction_deleteRegionAction :: Lens' UpdateReplicationSetAction (Maybe DeleteRegionAction)
Service Configuration
defaultService :: Service Source #
API version 2018-05-10 of the Amazon Systems Manager Incident Manager SDK configuration.
Errors
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You don't have sufficient access to perform this action.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Updating or deleting a resource causes an inconsistent state.
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request would cause a service quota to be exceeded.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied due to request throttling.
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request processing has failed because of an unknown error, exception or failure.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request references a resource which does not exist.
IncidentRecordStatus
newtype IncidentRecordStatus Source #
Constructors
| IncidentRecordStatus' | |
Fields | |
Bundled Patterns
| pattern IncidentRecordStatus_OPEN :: IncidentRecordStatus | |
| pattern IncidentRecordStatus_RESOLVED :: IncidentRecordStatus |
Instances
ItemType
Constructors
| ItemType' | |
Fields
| |
Bundled Patterns
| pattern ItemType_ANALYSIS :: ItemType | |
| pattern ItemType_ATTACHMENT :: ItemType | |
| pattern ItemType_INCIDENT :: ItemType | |
| pattern ItemType_METRIC :: ItemType | |
| pattern ItemType_OTHER :: ItemType | |
| pattern ItemType_PARENT :: ItemType |
Instances
RegionStatus
newtype RegionStatus Source #
Constructors
| RegionStatus' | |
Fields | |
Bundled Patterns
| pattern RegionStatus_ACTIVE :: RegionStatus | |
| pattern RegionStatus_CREATING :: RegionStatus | |
| pattern RegionStatus_DELETING :: RegionStatus | |
| pattern RegionStatus_FAILED :: RegionStatus |
Instances
ReplicationSetStatus
newtype ReplicationSetStatus Source #
Constructors
| ReplicationSetStatus' | |
Fields | |
Bundled Patterns
| pattern ReplicationSetStatus_ACTIVE :: ReplicationSetStatus | |
| pattern ReplicationSetStatus_CREATING :: ReplicationSetStatus | |
| pattern ReplicationSetStatus_DELETING :: ReplicationSetStatus | |
| pattern ReplicationSetStatus_FAILED :: ReplicationSetStatus | |
| pattern ReplicationSetStatus_UPDATING :: ReplicationSetStatus |
Instances
SortOrder
Constructors
| SortOrder' | |
Fields | |
Bundled Patterns
| pattern SortOrder_ASCENDING :: SortOrder | |
| pattern SortOrder_DESCENDING :: SortOrder |
Instances
SsmTargetAccount
newtype SsmTargetAccount Source #
Constructors
| SsmTargetAccount' | |
Fields | |
Bundled Patterns
| pattern SsmTargetAccount_IMPACTED_ACCOUNT :: SsmTargetAccount | |
| pattern SsmTargetAccount_RESPONSE_PLAN_OWNER_ACCOUNT :: SsmTargetAccount |
Instances
TimelineEventSort
newtype TimelineEventSort Source #
Constructors
| TimelineEventSort' | |
Fields | |
Bundled Patterns
| pattern TimelineEventSort_EVENT_TIME :: TimelineEventSort |
Instances
Action
The action that starts at the beginning of an incident. The response plan defines the action.
See: newAction smart constructor.
Constructors
| Action' | |
Fields
| |
Instances
| Eq Action Source # | |
| Read Action Source # | |
| Show Action Source # | |
| Generic Action Source # | |
| NFData Action Source # | |
Defined in Amazonka.SSMIncidents.Types.Action | |
| Hashable Action Source # | |
Defined in Amazonka.SSMIncidents.Types.Action | |
| ToJSON Action Source # | |
Defined in Amazonka.SSMIncidents.Types.Action | |
| FromJSON Action Source # | |
| type Rep Action Source # | |
Defined in Amazonka.SSMIncidents.Types.Action type Rep Action = D1 ('MetaData "Action" "Amazonka.SSMIncidents.Types.Action" "libZSservicesZSamazonka-ssm-incidentsZSamazonka-ssm-incidents" '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.
action_ssmAutomation :: Lens' Action (Maybe SsmAutomation) Source #
The Systems Manager automation document to start as the runbook at the beginning of the incident.
AddRegionAction
data AddRegionAction Source #
Defines the Region and KMS key to add to the replication set.
See: newAddRegionAction smart constructor.
Constructors
| AddRegionAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> AddRegionAction |
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 Region name to add to the replication set.
addRegionAction_sseKmsKeyId :: Lens' AddRegionAction (Maybe Text) Source #
The KMS key ID to use to encrypt your replication set.
addRegionAction_regionName :: Lens' AddRegionAction Text Source #
The 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.
Constructors
| AttributeValueList' | |
Fields
| |
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:stringValues:AttributeValueList', attributeValueList_stringValues - The list of string values that the filter matches.
$sel:integerValues:AttributeValueList', attributeValueList_integerValues - The list of integer values that the filter matches.
attributeValueList_stringValues :: Lens' AttributeValueList (Maybe [Text]) Source #
The list of string values that the filter matches.
attributeValueList_integerValues :: Lens' AttributeValueList (Maybe [Int]) Source #
The list of integer 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.
Constructors
| AutomationExecution' | |
Fields
| |
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.
automationExecution_ssmExecutionArn :: Lens' AutomationExecution (Maybe Text) Source #
The Amazon Resource Name (ARN) of the automation process.
ChatChannel
data ChatChannel Source #
The AWS Chatbot chat channel used for collaboration during an incident.
See: newChatChannel smart constructor.
Constructors
| ChatChannel' | |
Fields
| |
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:empty:ChatChannel', chatChannel_empty - Used to remove the chat channel from an incident record or response
plan.
$sel:chatbotSns:ChatChannel', chatChannel_chatbotSns - The SNS targets that AWS 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 SNS topics.
chatChannel_empty :: Lens' ChatChannel (Maybe EmptyChatChannel) Source #
Used to remove the chat channel from an incident record or response plan.
chatChannel_chatbotSns :: Lens' ChatChannel (Maybe (NonEmpty Text)) Source #
The SNS targets that AWS 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 SNS topics.
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 ANDed
statement. If multiple values are specified for a conditional, the
values are ORd.
See: newCondition smart constructor.
Constructors
| Condition' | |
Instances
| Eq Condition Source # | |
| Read Condition Source # | |
| Show Condition Source # | |
| Generic Condition Source # | |
| NFData Condition Source # | |
Defined in Amazonka.SSMIncidents.Types.Condition | |
| Hashable Condition Source # | |
Defined in Amazonka.SSMIncidents.Types.Condition | |
| ToJSON 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" "libZSservicesZSamazonka-ssm-incidentsZSamazonka-ssm-incidents" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "equals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValueList)) :*: S1 ('MetaSel ('Just "before") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) | |
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:equals:Condition', condition_equals - The value is equal to the provided string or integer.
$sel:before:Condition', condition_before - Before the specified timestamp
condition_equals :: Lens' Condition (Maybe AttributeValueList) Source #
The value is equal to the provided string or integer.
DeleteRegionAction
data DeleteRegionAction Source #
Defines the information about the Region you're deleting from your replication set.
See: newDeleteRegionAction smart constructor.
Constructors
| DeleteRegionAction' | |
Fields
| |
Instances
newDeleteRegionAction Source #
Arguments
| :: Text | |
| -> DeleteRegionAction |
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 Region you're deleting from the replication set.
deleteRegionAction_regionName :: Lens' DeleteRegionAction Text Source #
The name of the Region you're deleting from the replication set.
EmptyChatChannel
data EmptyChatChannel Source #
Used to remove the chat channel from an incident record or response plan.
See: newEmptyChatChannel smart constructor.
Constructors
| EmptyChatChannel' | |
Instances
newEmptyChatChannel :: EmptyChatChannel Source #
Create a value of EmptyChatChannel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
EventSummary
data EventSummary Source #
Details about a timeline event during an incident.
See: newEventSummary smart constructor.
Constructors
| EventSummary' | |
Fields
| |
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: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.
eventSummary_eventId :: Lens' EventSummary Text Source #
The timeline event ID.
eventSummary_eventTime :: Lens' EventSummary UTCTime Source #
The time that the event occurred.
eventSummary_eventType :: Lens' EventSummary Text Source #
The type of event. The timeline event must be Custom Event.
eventSummary_eventUpdatedTime :: Lens' EventSummary UTCTime Source #
The time that the timeline event was last updated.
eventSummary_incidentRecordArn :: Lens' EventSummary Text Source #
The Amazon Resource Name (ARN) of the incident that the event happened during.
Filter
Filter the selection by using a condition.
See: newFilter smart constructor.
Constructors
| Filter' | |
Instances
| Eq Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| Generic Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.SSMIncidents.Types.Filter | |
| Hashable Filter Source # | |
Defined in Amazonka.SSMIncidents.Types.Filter | |
| ToJSON 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" "libZSservicesZSamazonka-ssm-incidentsZSamazonka-ssm-incidents" '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.
filter_condition :: Lens' Filter Condition Source #
The condition accepts before or after a specified time, equal to a string, or equal to an integer.
IncidentRecord
data IncidentRecord Source #
The record of the incident that's created when an incident occurs.
See: newIncidentRecord smart constructor.
Constructors
| IncidentRecord' | |
Fields
| |
Instances
Arguments
| :: 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:summary:IncidentRecord', incidentRecord_summary - The summary of the incident. The summary is a brief synopsis of what
occurred, what is currently happening, and context.
$sel:notificationTargets:IncidentRecord', incidentRecord_notificationTargets - The 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:chatChannel:IncidentRecord', incidentRecord_chatChannel - The chat channel used for collaboration during an incident.
$sel:automationExecutions:IncidentRecord', incidentRecord_automationExecutions - The runbook, or automation document, that's run at the beginning 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.
$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.
incidentRecord_summary :: Lens' IncidentRecord (Maybe Text) Source #
The summary of the incident. The summary is a brief synopsis of what occurred, what is currently happening, and context.
incidentRecord_notificationTargets :: Lens' IncidentRecord (Maybe [NotificationTargetItem]) Source #
The SNS targets that are notified when updates are made to an incident.
incidentRecord_resolvedTime :: Lens' IncidentRecord (Maybe UTCTime) Source #
The time at which the incident was resolved. This appears as a timeline event.
incidentRecord_chatChannel :: Lens' IncidentRecord (Maybe ChatChannel) Source #
The chat channel used for collaboration during an incident.
incidentRecord_automationExecutions :: Lens' IncidentRecord (Maybe [AutomationExecution]) Source #
The runbook, or automation document, that's run at the beginning of the incident.
incidentRecord_arn :: Lens' IncidentRecord Text Source #
The Amazon Resource Name (ARN) of the incident record.
incidentRecord_creationTime :: Lens' IncidentRecord UTCTime Source #
The time that Incident Manager created the incident record.
incidentRecord_dedupeString :: Lens' IncidentRecord Text Source #
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident.
incidentRecord_impact :: Lens' IncidentRecord Natural Source #
The impact of the incident on customers and applications.
incidentRecord_incidentRecordSource :: Lens' IncidentRecord IncidentRecordSource Source #
Details about the action that started the incident.
incidentRecord_lastModifiedBy :: Lens' IncidentRecord Text Source #
Who modified the incident most recently.
incidentRecord_lastModifiedTime :: Lens' IncidentRecord UTCTime Source #
The time at which the incident was most recently modified.
incidentRecord_status :: Lens' IncidentRecord IncidentRecordStatus Source #
The current status of the incident.
incidentRecord_title :: Lens' IncidentRecord Text Source #
The title of the incident.
IncidentRecordSource
data IncidentRecordSource Source #
Details about how the incident record was created and when.
See: newIncidentRecordSource smart constructor.
Constructors
| IncidentRecordSource' | |
Fields
| |
Instances
newIncidentRecordSource Source #
Arguments
| :: 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 principal the assumed the role specified of the createdBy.
$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 AWS CloudWatch alarm,
or Amazon EventBridge event.
incidentRecordSource_invokedBy :: Lens' IncidentRecordSource (Maybe Text) Source #
The principal the assumed the role specified of the createdBy.
incidentRecordSource_resourceArn :: Lens' IncidentRecordSource (Maybe Text) Source #
The resource that caused the incident to be created.
incidentRecordSource_createdBy :: Lens' IncidentRecordSource Text Source #
The principal that started the incident.
incidentRecordSource_source :: Lens' IncidentRecordSource Text Source #
The service that started the incident. This can be manually created from Incident Manager, automatically created using an AWS CloudWatch alarm, or Amazon EventBridge event.
IncidentRecordSummary
data IncidentRecordSummary Source #
Details describing an incident record.
See: newIncidentRecordSummary smart constructor.
Constructors
| IncidentRecordSummary' | |
Fields
| |
Instances
newIncidentRecordSummary Source #
Arguments
| :: 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.
incidentRecordSummary_resolvedTime :: Lens' IncidentRecordSummary (Maybe UTCTime) Source #
The time the incident was resolved.
incidentRecordSummary_arn :: Lens' IncidentRecordSummary Text Source #
The Amazon Resource Name (ARN) of the incident.
incidentRecordSummary_creationTime :: Lens' IncidentRecordSummary UTCTime Source #
The time the incident was created.
incidentRecordSummary_impact :: Lens' IncidentRecordSummary Natural Source #
Defines the impact to customers and applications.
incidentRecordSummary_incidentRecordSource :: Lens' IncidentRecordSummary IncidentRecordSource Source #
What caused Incident Manager to create the incident.
incidentRecordSummary_status :: Lens' IncidentRecordSummary IncidentRecordStatus Source #
The current status of the incident.
incidentRecordSummary_title :: Lens' IncidentRecordSummary Text Source #
The title of the incident. This value is either provided by the response plan or overwritten on creation.
IncidentTemplate
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.
Constructors
| IncidentTemplate' | |
Fields
| |
Instances
Arguments
| :: Natural | |
| -> Text | |
| -> IncidentTemplate |
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: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:notificationTargets:IncidentTemplate', incidentTemplate_notificationTargets - The SNS targets that are notified when updates are made to an incident.
$sel:dedupeString:IncidentTemplate', incidentTemplate_dedupeString - Used to stop Incident Manager from creating multiple incident records
for the same incident.
$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.
incidentTemplate_summary :: Lens' IncidentTemplate (Maybe Text) Source #
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
incidentTemplate_notificationTargets :: Lens' IncidentTemplate (Maybe [NotificationTargetItem]) Source #
The SNS targets that are notified when updates are made to an incident.
incidentTemplate_dedupeString :: Lens' IncidentTemplate (Maybe Text) Source #
Used to stop Incident Manager from creating multiple incident records for the same incident.
incidentTemplate_impact :: Lens' IncidentTemplate Natural Source #
The impact of the incident on your customers and applications.
incidentTemplate_title :: Lens' IncidentTemplate Text Source #
The title of the incident.
ItemIdentifier
data ItemIdentifier Source #
Details and type of a related item.
See: newItemIdentifier smart constructor.
Constructors
| ItemIdentifier' | |
Instances
Arguments
| :: ItemType | |
| -> ItemValue | |
| -> ItemIdentifier |
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. Incident Manager supports the following types:
ANALYSIS
INCIDENT
METRIC
PARENT
ATTACHMENT
OTHER
$sel:value:ItemIdentifier', itemIdentifier_value - Details about the related item.
itemIdentifier_type :: Lens' ItemIdentifier ItemType Source #
The type of related item. Incident Manager supports the following types:
ANALYSIS
INCIDENT
METRIC
PARENT
ATTACHMENT
OTHER
itemIdentifier_value :: Lens' ItemIdentifier ItemValue Source #
Details about the related item.
ItemValue
Describes a related item.
See: newItemValue smart constructor.
Constructors
| ItemValue' | |
Instances
| Eq ItemValue Source # | |
| Read ItemValue Source # | |
| Show ItemValue Source # | |
| Generic ItemValue Source # | |
| NFData ItemValue Source # | |
Defined in Amazonka.SSMIncidents.Types.ItemValue | |
| Hashable ItemValue Source # | |
Defined in Amazonka.SSMIncidents.Types.ItemValue | |
| ToJSON ItemValue Source # | |
Defined in Amazonka.SSMIncidents.Types.ItemValue | |
| FromJSON ItemValue Source # | |
| type Rep ItemValue Source # | |
Defined in Amazonka.SSMIncidents.Types.ItemValue type Rep ItemValue = D1 ('MetaData "ItemValue" "Amazonka.SSMIncidents.Types.ItemValue" "libZSservicesZSamazonka-ssm-incidentsZSamazonka-ssm-incidents" 'False) (C1 ('MetaCons "ItemValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metricDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
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:url:ItemValue', itemValue_url - The URL, if the related item is a non-AWS resource.
$sel:metricDefinition:ItemValue', itemValue_metricDefinition - The metric definition, if the related item is a metric in CloudWatch.
itemValue_arn :: Lens' ItemValue (Maybe Text) Source #
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
itemValue_url :: Lens' ItemValue (Maybe Text) Source #
The URL, if the related item is a non-AWS resource.
itemValue_metricDefinition :: Lens' ItemValue (Maybe Text) Source #
The metric definition, if the related item is a metric in CloudWatch.
NotificationTargetItem
data NotificationTargetItem Source #
The SNS targets that are notified when updates are made to an incident.
See: newNotificationTargetItem smart constructor.
Constructors
| NotificationTargetItem' | |
Fields
| |
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.
notificationTargetItem_snsTopicArn :: Lens' NotificationTargetItem (Maybe Text) Source #
The Amazon Resource Name (ARN) of the SNS topic.
RegionInfo
data RegionInfo Source #
Information about a Region in your replication set.
See: newRegionInfo smart constructor.
Constructors
| RegionInfo' | |
Fields
| |
Instances
Arguments
| :: RegionStatus | |
| -> UTCTime | |
| -> RegionInfo |
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:statusMessage:RegionInfo', regionInfo_statusMessage - Information displayed about the status of the Region.
$sel:sseKmsKeyId:RegionInfo', regionInfo_sseKmsKeyId - The ID of the KMS key used to encrypt the data in this Region.
$sel:status:RegionInfo', regionInfo_status - The status of the Region in the replication set.
$sel:statusUpdateDateTime:RegionInfo', regionInfo_statusUpdateDateTime - The most recent date and time that the Region's status was updated.
regionInfo_statusMessage :: Lens' RegionInfo (Maybe Text) Source #
Information displayed about the status of the Region.
regionInfo_sseKmsKeyId :: Lens' RegionInfo (Maybe Text) Source #
The ID of the KMS key used to encrypt the data in this Region.
regionInfo_status :: Lens' RegionInfo RegionStatus Source #
The status of the Region in the replication set.
regionInfo_statusUpdateDateTime :: Lens' RegionInfo UTCTime Source #
The most recent date and time that the Region's status was updated.
RegionMapInputValue
data RegionMapInputValue Source #
The mapping between a Region and the key that's used to encrypt the data.
See: newRegionMapInputValue smart constructor.
Constructors
| RegionMapInputValue' | |
Fields
| |
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.
regionMapInputValue_sseKmsKeyId :: Lens' RegionMapInputValue (Maybe Text) Source #
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.
Constructors
| RelatedItem' | |
Fields
| |
Instances
Arguments
| :: ItemIdentifier | |
| -> RelatedItem |
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:title:RelatedItem', relatedItem_title - The title of the related item.
$sel:identifier:RelatedItem', relatedItem_identifier - Details about the related item.
relatedItem_title :: Lens' RelatedItem (Maybe Text) Source #
The title of the related item.
relatedItem_identifier :: Lens' RelatedItem ItemIdentifier Source #
Details about the related item.
RelatedItemsUpdate
data RelatedItemsUpdate Source #
Details about the related item you're adding.
See: newRelatedItemsUpdate smart constructor.
Constructors
| RelatedItemsUpdate' | |
Fields
| |
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:itemToRemove:RelatedItemsUpdate', relatedItemsUpdate_itemToRemove - Details about the related item you're deleting.
$sel:itemToAdd:RelatedItemsUpdate', relatedItemsUpdate_itemToAdd - Details about the related item you're adding.
relatedItemsUpdate_itemToRemove :: Lens' RelatedItemsUpdate (Maybe ItemIdentifier) Source #
Details about the related item you're deleting.
relatedItemsUpdate_itemToAdd :: Lens' RelatedItemsUpdate (Maybe RelatedItem) Source #
Details about the related item you're adding.
ReplicationSet
data ReplicationSet Source #
The set of Regions that your Incident Manager data will be replicated to and the KMS key used to encrypt the data.
See: newReplicationSet smart constructor.
Constructors
| ReplicationSet' | |
Fields
| |
Instances
Arguments
| :: 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 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 Region in your replication set and the KMS key that
is used to encrypt the data in that Region.
$sel:status:ReplicationSet', replicationSet_status - The status of the replication set. If the replication set is still
pending, you can't use Incident Manager functionality.
replicationSet_arn :: Lens' ReplicationSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the replication set.
replicationSet_createdBy :: Lens' ReplicationSet Text Source #
Details about who created the replication set.
replicationSet_createdTime :: Lens' ReplicationSet UTCTime Source #
When the replication set was created.
replicationSet_deletionProtected :: Lens' ReplicationSet Bool Source #
Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Region in the replication set.
replicationSet_lastModifiedBy :: Lens' ReplicationSet Text Source #
Who last modified the replication set.
replicationSet_lastModifiedTime :: Lens' ReplicationSet UTCTime Source #
When the replication set was last updated.
replicationSet_regionMap :: Lens' ReplicationSet (HashMap Text RegionInfo) Source #
The map between each Region in your replication set and the KMS key that is used to encrypt the data in that Region.
replicationSet_status :: Lens' ReplicationSet ReplicationSetStatus Source #
The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.
ResourcePolicy
data ResourcePolicy Source #
The resource policy that allows Incident Manager to perform actions on resources on your behalf.
See: newResourcePolicy smart constructor.
Constructors
| ResourcePolicy' | |
Fields
| |
Instances
Arguments
| :: 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 Region that policy allows resources to be used in.
resourcePolicy_policyDocument :: Lens' ResourcePolicy Text Source #
The JSON blob that describes the policy.
resourcePolicy_policyId :: Lens' ResourcePolicy Text Source #
The ID of the resource policy.
resourcePolicy_ramResourceShareRegion :: Lens' ResourcePolicy Text Source #
The 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.
Constructors
| ResponsePlanSummary' | |
Instances
newResponsePlanSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> ResponsePlanSummary |
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.
responsePlanSummary_displayName :: Lens' ResponsePlanSummary (Maybe Text) Source #
The human readable name of the response plan. This can include spaces.
responsePlanSummary_arn :: Lens' ResponsePlanSummary Text Source #
The Amazon Resource Name (ARN) of the response plan.
responsePlanSummary_name :: Lens' ResponsePlanSummary Text Source #
The name of the response plan. This can't include spaces.
SsmAutomation
data SsmAutomation Source #
Details about the Systems Manager automation document that will be used as a runbook during an incident.
See: newSsmAutomation smart constructor.
Constructors
| SsmAutomation' | |
Fields
| |
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: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:parameters:SsmAutomation', ssmAutomation_parameters - The key-value pair parameters to use when running the automation
document.
$sel:documentVersion:SsmAutomation', ssmAutomation_documentVersion - The automation document's version to use when running.
$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.
ssmAutomation_targetAccount :: Lens' SsmAutomation (Maybe SsmTargetAccount) Source #
The account that the automation document will be run in. This can be in either the management account or an application account.
ssmAutomation_parameters :: Lens' SsmAutomation (Maybe (HashMap Text [Text])) Source #
The key-value pair parameters to use when running the automation document.
ssmAutomation_documentVersion :: Lens' SsmAutomation (Maybe Text) Source #
The automation document's version to use when running.
ssmAutomation_documentName :: Lens' SsmAutomation Text Source #
The automation document's name.
ssmAutomation_roleArn :: Lens' SsmAutomation Text Source #
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
TimelineEvent
data TimelineEvent Source #
A significant event that happened during the incident.
See: newTimelineEvent smart constructor.
Constructors
| TimelineEvent' | |
Fields
| |
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: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.
timelineEvent_eventData :: Lens' TimelineEvent Text Source #
A short description of the event.
timelineEvent_eventId :: Lens' TimelineEvent Text Source #
The ID of the timeline event.
timelineEvent_eventTime :: Lens' TimelineEvent UTCTime Source #
The time that the event occurred.
timelineEvent_eventType :: Lens' TimelineEvent Text Source #
The type of event that occurred. Currently Incident Manager supports
only the Custom Event type.
timelineEvent_eventUpdatedTime :: Lens' TimelineEvent UTCTime Source #
The time that the timeline event was last updated.
timelineEvent_incidentRecordArn :: Lens' TimelineEvent Text Source #
The Amazon Resource Name (ARN) of the incident that the event occurred during.
TriggerDetails
data TriggerDetails Source #
Details about what caused the incident to be created in Incident Manager.
See: newTriggerDetails smart constructor.
Constructors
| TriggerDetails' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> TriggerDetails |
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 EventBridge, CloudWatch, or Incident Manager
when an incident is created.
$sel:triggerArn:TriggerDetails', triggerDetails_triggerArn - The 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 AWS 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.
triggerDetails_rawData :: Lens' TriggerDetails (Maybe Text) Source #
Raw data passed from either EventBridge, CloudWatch, or Incident Manager when an incident is created.
triggerDetails_triggerArn :: Lens' TriggerDetails (Maybe Text) Source #
The ARN of the source that detected the incident.
triggerDetails_source :: Lens' TriggerDetails Text Source #
Identifies the service that sourced the event. All events sourced from within AWS begin with "aws." Customer-generated events can have any value here, as long as it doesn't begin with "aws." We recommend the use of Java package-name style reverse domain-name strings.
triggerDetails_timestamp :: Lens' TriggerDetails UTCTime Source #
The time that the incident was detected.
UpdateReplicationSetAction
data UpdateReplicationSetAction Source #
Details used when updating the replication set.
See: newUpdateReplicationSetAction smart constructor.
Constructors
| UpdateReplicationSetAction' | |
Fields
| |
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 Region that you're adding to the replication set.
$sel:deleteRegionAction:UpdateReplicationSetAction', updateReplicationSetAction_deleteRegionAction - Details about the Region that you're deleting to the replication set.
updateReplicationSetAction_addRegionAction :: Lens' UpdateReplicationSetAction (Maybe AddRegionAction) Source #
Details about the Region that you're adding to the replication set.
updateReplicationSetAction_deleteRegionAction :: Lens' UpdateReplicationSetAction (Maybe DeleteRegionAction) Source #
Details about the Region that you're deleting to the replication set.