libZSservicesZSamazonka-ssm-incidentsZSamazonka-ssm-incidents
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSMIncidents.Lens

Description

 
Synopsis

Operations

DeleteReplicationSet

deleteReplicationSet_arn :: Lens' DeleteReplicationSet Text Source #

The Amazon Resource Name (ARN) of the replication set you're deleting.

UpdateReplicationSet

updateReplicationSet_clientToken :: Lens' UpdateReplicationSet (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

updateReplicationSet_arn :: Lens' UpdateReplicationSet Text Source #

The Amazon Resource Name (ARN) of the replication set you're updating.

ListReplicationSets

listReplicationSets_nextToken :: Lens' ListReplicationSets (Maybe Text) Source #

The pagination token to continue to the next page of results.

listReplicationSets_maxResults :: Lens' ListReplicationSets (Maybe Natural) Source #

The maximum number of results per page.

listReplicationSetsResponse_nextToken :: Lens' ListReplicationSetsResponse (Maybe Text) Source #

The pagination token to continue to the next page of results.

listReplicationSetsResponse_replicationSetArns :: Lens' ListReplicationSetsResponse [Text] Source #

The Amazon Resource Name (ARN) of the list replication set.

UpdateIncidentRecord

updateIncidentRecord_summary :: Lens' UpdateIncidentRecord (Maybe Text) Source #

The summary describes what has happened during the incident.

updateIncidentRecord_status :: Lens' UpdateIncidentRecord (Maybe IncidentRecordStatus) Source #

The status of the incident. An incident can be Open or Resolved.

updateIncidentRecord_notificationTargets :: Lens' UpdateIncidentRecord (Maybe [NotificationTargetItem]) Source #

The SNS targets that are notified when updates are made to an incident.

Using multiple SNS topics creates redundancy in the case that a Region is down during the incident.

updateIncidentRecord_clientToken :: Lens' UpdateIncidentRecord (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

updateIncidentRecord_impact :: Lens' UpdateIncidentRecord (Maybe Natural) Source #

Defines the impact to customers and applications. Providing an impact overwrites the impact provided by the 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.

updateIncidentRecord_chatChannel :: Lens' UpdateIncidentRecord (Maybe ChatChannel) Source #

The AWS Chatbot chat channel for responders to collaborate in.

updateIncidentRecord_title :: Lens' UpdateIncidentRecord (Maybe Text) Source #

The title of the incident is a brief and easily recognizable.

updateIncidentRecord_arn :: Lens' UpdateIncidentRecord Text Source #

The Amazon Resource Name (ARN) of the incident record you are updating.

DeleteIncidentRecord

deleteIncidentRecord_arn :: Lens' DeleteIncidentRecord Text Source #

The Amazon Resource Name (ARN) of the incident record you are deleting.

CreateReplicationSet

createReplicationSet_clientToken :: Lens' CreateReplicationSet (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

createReplicationSet_regions :: Lens' CreateReplicationSet (HashMap Text RegionMapInputValue) Source #

The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.

createReplicationSetResponse_arn :: Lens' CreateReplicationSetResponse Text Source #

The Amazon Resource Name (ARN) of the replication set.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the response plan.

GetResourcePolicies

getResourcePolicies_nextToken :: Lens' GetResourcePolicies (Maybe Text) Source #

The pagination token to continue to the next page of results.

getResourcePolicies_maxResults :: Lens' GetResourcePolicies (Maybe Natural) Source #

The maximum number of resource policies to display per page of results.

getResourcePolicies_resourceArn :: Lens' GetResourcePolicies Text Source #

The Amazon Resource Name (ARN) of the response plan with the attached resource policy.

getResourcePoliciesResponse_nextToken :: Lens' GetResourcePoliciesResponse (Maybe Text) Source #

The pagination token to continue to the next page of results.

getResourcePoliciesResponse_resourcePolicies :: Lens' GetResourcePoliciesResponse [ResourcePolicy] Source #

Details about the resource policy attached to the response plan.

GetIncidentRecord

getIncidentRecord_arn :: Lens' GetIncidentRecord Text Source #

The Amazon Resource Name (ARN) of the incident record.

GetReplicationSet

getReplicationSet_arn :: Lens' GetReplicationSet Text Source #

The Amazon Resource Name (ARN) of the replication set you want to retrieve.

ListRelatedItems

listRelatedItems_nextToken :: Lens' ListRelatedItems (Maybe Text) Source #

The pagination token to continue to the next page of results.

listRelatedItems_maxResults :: Lens' ListRelatedItems (Maybe Natural) Source #

The maximum number of related items per page.

listRelatedItems_incidentRecordArn :: Lens' ListRelatedItems Text Source #

The Amazon Resource Name (ARN) of the incident record that you are listing related items for.

listRelatedItemsResponse_nextToken :: Lens' ListRelatedItemsResponse (Maybe Text) Source #

The pagination token to continue to the next page of results.

UpdateDeletionProtection

updateDeletionProtection_clientToken :: Lens' UpdateDeletionProtection (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

updateDeletionProtection_arn :: Lens' UpdateDeletionProtection Text Source #

The Amazon Resource Name (ARN) of the replication set you're updating.

updateDeletionProtection_deletionProtected :: Lens' UpdateDeletionProtection Bool Source #

Details if deletion protection is enabled or disabled in your account.

GetResponsePlan

getResponsePlan_arn :: Lens' GetResponsePlan Text Source #

The Amazon Resource Name (ARN) of the response plan.

getResponsePlanResponse_actions :: Lens' GetResponsePlanResponse (Maybe [Action]) Source #

The actions that this response plan takes at the beginning of the incident.

getResponsePlanResponse_displayName :: Lens' GetResponsePlanResponse (Maybe Text) Source #

The long format name of the response plan. Can contain spaces.

getResponsePlanResponse_chatChannel :: Lens' GetResponsePlanResponse (Maybe ChatChannel) Source #

The AWS Chatbot chat channel used for collaboration during an incident.

getResponsePlanResponse_engagements :: Lens' GetResponsePlanResponse (Maybe [Text]) Source #

The contacts and escalation plans that the response plan engages during an incident.

getResponsePlanResponse_incidentTemplate :: Lens' GetResponsePlanResponse IncidentTemplate Source #

Details used to create the incident when using this response plan.

getResponsePlanResponse_name :: Lens' GetResponsePlanResponse Text Source #

The short format name of the response plan. Can't contain spaces.

CreateResponsePlan

createResponsePlan_clientToken :: Lens' CreateResponsePlan (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

createResponsePlan_actions :: Lens' CreateResponsePlan (Maybe [Action]) Source #

The actions that the response plan starts at the beginning of an incident.

createResponsePlan_displayName :: Lens' CreateResponsePlan (Maybe Text) Source #

The long format of the response plan name. This field can contain spaces.

createResponsePlan_chatChannel :: Lens' CreateResponsePlan (Maybe ChatChannel) Source #

The AWS Chatbot chat channel used for collaboration during an incident.

createResponsePlan_engagements :: Lens' CreateResponsePlan (Maybe [Text]) Source #

The contacts and escalation plans that the response plan engages during an incident.

createResponsePlan_tags :: Lens' CreateResponsePlan (Maybe (HashMap Text Text)) Source #

A list of tags that you are adding to the response plan.

createResponsePlan_incidentTemplate :: Lens' CreateResponsePlan IncidentTemplate Source #

Details used to create an incident when using this response plan.

createResponsePlan_name :: Lens' CreateResponsePlan Text Source #

The short format name of the response plan. Can't include spaces.

createResponsePlanResponse_arn :: Lens' CreateResponsePlanResponse Text Source #

The Amazon Resource Name (ARN) of the response plan.

ListIncidentRecords

listIncidentRecords_filters :: Lens' ListIncidentRecords (Maybe [Filter]) Source #

Filter the list of incident records you are searching through. You can filter on the following keys:

  • creationTime
  • impact
  • status
  • createdBy

listIncidentRecords_nextToken :: Lens' ListIncidentRecords (Maybe Text) Source #

The pagination token to continue to the next page of results.

listIncidentRecords_maxResults :: Lens' ListIncidentRecords (Maybe Natural) Source #

The maximum number of results per page.

listIncidentRecordsResponse_nextToken :: Lens' ListIncidentRecordsResponse (Maybe Text) Source #

The pagination token to continue to the next page of results.

UpdateRelatedItems

updateRelatedItems_clientToken :: Lens' UpdateRelatedItems (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

updateRelatedItems_incidentRecordArn :: Lens' UpdateRelatedItems Text Source #

The Amazon Resource Name (ARN) of the incident record you are updating related items in.

updateRelatedItems_relatedItemsUpdate :: Lens' UpdateRelatedItems RelatedItemsUpdate Source #

Details about the item you are adding or deleting.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the response plan you're adding the tags to.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

A list of tags that you are adding to the response plan.

PutResourcePolicy

putResourcePolicy_policy :: Lens' PutResourcePolicy Text Source #

Details of the resource policy.

putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the response plan you're adding the resource policy to.

DeleteResourcePolicy

deleteResourcePolicy_policyId :: Lens' DeleteResourcePolicy Text Source #

The ID of the resource policy you're deleting.

deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the resource you're deleting the policy from.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the response plan you're removing a tag from.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The name of the tag you're removing from the response plan.

CreateTimelineEvent

createTimelineEvent_clientToken :: Lens' CreateTimelineEvent (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

createTimelineEvent_eventData :: Lens' CreateTimelineEvent Text Source #

A valid JSON string. There is no other schema imposed. A short description of the event.

createTimelineEvent_eventType :: Lens' CreateTimelineEvent Text Source #

The type of the event. You can create timeline events of type Custom Event.

createTimelineEvent_incidentRecordArn :: Lens' CreateTimelineEvent Text Source #

The Amazon Resource Name (ARN) of the incident record you are adding the event to.

createTimelineEventResponse_eventId :: Lens' CreateTimelineEventResponse Text Source #

The ID of the event for easy reference later.

createTimelineEventResponse_incidentRecordArn :: Lens' CreateTimelineEventResponse Text Source #

The ARN of the incident record that you added the event to.

ListTimelineEvents

listTimelineEvents_filters :: Lens' ListTimelineEvents (Maybe [Filter]) Source #

Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:

  • eventTime
  • eventType

listTimelineEvents_sortOrder :: Lens' ListTimelineEvents (Maybe SortOrder) Source #

Sorts the order of timeline events by the value specified in the sortBy field.

listTimelineEvents_nextToken :: Lens' ListTimelineEvents (Maybe Text) Source #

The pagination token to continue to the next page of results.

listTimelineEvents_maxResults :: Lens' ListTimelineEvents (Maybe Natural) Source #

The maximum number of results per page.

listTimelineEvents_incidentRecordArn :: Lens' ListTimelineEvents Text Source #

The Amazon Resource Name (ARN) of the incident that the event is part of.

listTimelineEventsResponse_nextToken :: Lens' ListTimelineEventsResponse (Maybe Text) Source #

The pagination token to continue to the next page of results.

listTimelineEventsResponse_eventSummaries :: Lens' ListTimelineEventsResponse [EventSummary] Source #

Details about each event that occurred during the incident.

StartIncident

startIncident_clientToken :: Lens' StartIncident (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

startIncident_triggerDetails :: Lens' StartIncident (Maybe TriggerDetails) Source #

Details of what created the incident record in Incident Manager.

startIncident_relatedItems :: Lens' StartIncident (Maybe [RelatedItem]) Source #

Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an S3 bucket.

startIncident_impact :: Lens' StartIncident (Maybe Natural) Source #

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Possible impacts:

  • 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.
  • 2 - High impact, partial application failure with impact to many customers.
  • 3 - Medium impact, the application is providing reduced service to customers.
  • 4 - Low impact, customer might aren't impacted by the problem yet.
  • 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

startIncident_title :: Lens' StartIncident (Maybe Text) Source #

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

startIncident_responsePlanArn :: Lens' StartIncident Text Source #

The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident.

startIncidentResponse_incidentRecordArn :: Lens' StartIncidentResponse Text Source #

The ARN of the newly created incident record.

DeleteTimelineEvent

deleteTimelineEvent_eventId :: Lens' DeleteTimelineEvent Text Source #

The ID of the event you are updating. You can find this by using ListTimelineEvents.

deleteTimelineEvent_incidentRecordArn :: Lens' DeleteTimelineEvent Text Source #

The Amazon Resource Name (ARN) of the incident that the event is part of.

UpdateTimelineEvent

updateTimelineEvent_clientToken :: Lens' UpdateTimelineEvent (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

updateTimelineEvent_eventType :: Lens' UpdateTimelineEvent (Maybe Text) Source #

The type of the event. You can update events of type Custom Event.

updateTimelineEvent_eventId :: Lens' UpdateTimelineEvent Text Source #

The ID of the event you are updating. You can find this by using ListTimelineEvents.

updateTimelineEvent_incidentRecordArn :: Lens' UpdateTimelineEvent Text Source #

The Amazon Resource Name (ARN) of the incident that the timeline event is part of.

ListResponsePlans

listResponsePlans_nextToken :: Lens' ListResponsePlans (Maybe Text) Source #

The pagination token to continue to the next page of results.

listResponsePlans_maxResults :: Lens' ListResponsePlans (Maybe Natural) Source #

The maximum number of response plans per page.

listResponsePlansResponse_nextToken :: Lens' ListResponsePlansResponse (Maybe Text) Source #

The pagination token to continue to the next page of results.

GetTimelineEvent

getTimelineEvent_eventId :: Lens' GetTimelineEvent Text Source #

The ID of the event. You can get an event's ID when you create it or by using ListTimelineEvents.

getTimelineEvent_incidentRecordArn :: Lens' GetTimelineEvent Text Source #

The Amazon Resource Name (ARN) of the incident that the timeline event is part of.

UpdateResponsePlan

updateResponsePlan_incidentTemplateImpact :: Lens' UpdateResponsePlan (Maybe Natural) Source #

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Possible impacts:

  • 5 - Severe impact
  • 4 - High impact
  • 3 - Medium impact
  • 2 - Low impact
  • 1 - No impact

updateResponsePlan_clientToken :: Lens' UpdateResponsePlan (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

updateResponsePlan_actions :: Lens' UpdateResponsePlan (Maybe [Action]) Source #

The actions that this response plan takes at the beginning of an incident.

updateResponsePlan_incidentTemplateSummary :: Lens' UpdateResponsePlan (Maybe Text) Source #

A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

updateResponsePlan_displayName :: Lens' UpdateResponsePlan (Maybe Text) Source #

The long format name of the response plan. Can't contain spaces.

updateResponsePlan_chatChannel :: Lens' UpdateResponsePlan (Maybe ChatChannel) Source #

The AWS Chatbot chat channel used for collaboration during an incident.

Use the empty structure to remove the chat channel from the response plan.

updateResponsePlan_incidentTemplateDedupeString :: Lens' UpdateResponsePlan (Maybe Text) Source #

Used to create only one incident record for an incident.

updateResponsePlan_incidentTemplateTitle :: Lens' UpdateResponsePlan (Maybe Text) Source #

The short format name of the incident. Can't contain spaces.

updateResponsePlan_engagements :: Lens' UpdateResponsePlan (Maybe [Text]) Source #

The contacts and escalation plans that Incident Manager engages at the start of the incident.

updateResponsePlan_incidentTemplateNotificationTargets :: Lens' UpdateResponsePlan (Maybe [NotificationTargetItem]) Source #

The SNS targets that are notified when updates are made to an incident.

updateResponsePlan_arn :: Lens' UpdateResponsePlan Text Source #

The Amazon Resource Name (ARN) of the response plan.

DeleteResponsePlan

deleteResponsePlan_arn :: Lens' DeleteResponsePlan Text Source #

The Amazon Resource Name (ARN) of the response plan.

Types

Action

action_ssmAutomation :: Lens' Action (Maybe SsmAutomation) Source #

The Systems Manager automation document to start as the runbook at the beginning of the incident.

AddRegionAction

addRegionAction_sseKmsKeyId :: Lens' AddRegionAction (Maybe Text) Source #

The KMS key ID to use to encrypt your replication set.

addRegionAction_regionName :: Lens' AddRegionAction Text Source #

The Region name to add to the replication set.

AttributeValueList

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

automationExecution_ssmExecutionArn :: Lens' AutomationExecution (Maybe Text) Source #

The Amazon Resource Name (ARN) of the automation process.

ChatChannel

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

condition_after :: Lens' Condition (Maybe UTCTime) Source #

After the specified timestamp.

condition_equals :: Lens' Condition (Maybe AttributeValueList) Source #

The value is equal to the provided string or integer.

condition_before :: Lens' Condition (Maybe UTCTime) Source #

Before the specified timestamp

DeleteRegionAction

deleteRegionAction_regionName :: Lens' DeleteRegionAction Text Source #

The name of the Region you're deleting from the replication set.

EmptyChatChannel

EventSummary

eventSummary_eventTime :: Lens' EventSummary UTCTime Source #

The time that the event occurred.

eventSummary_eventType :: Lens' EventSummary Text Source #

The type of event. The timeline event must be Custom Event.

eventSummary_eventUpdatedTime :: Lens' EventSummary UTCTime Source #

The time that the timeline event was last updated.

eventSummary_incidentRecordArn :: Lens' EventSummary Text Source #

The Amazon Resource Name (ARN) of the incident that the event happened during.

Filter

filter_condition :: Lens' Filter Condition Source #

The condition accepts before or after a specified time, equal to a string, or equal to an integer.

filter_key :: Lens' Filter Text Source #

The key that you're filtering on.

IncidentRecord

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_title :: Lens' IncidentRecord Text Source #

The title of the incident.

IncidentRecordSource

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

incidentRecordSummary_arn :: Lens' IncidentRecordSummary Text Source #

The Amazon Resource Name (ARN) of the incident.

incidentRecordSummary_impact :: Lens' IncidentRecordSummary Natural Source #

Defines the impact to customers and applications.

incidentRecordSummary_title :: Lens' IncidentRecordSummary Text Source #

The title of the incident. This value is either provided by the response plan or overwritten on creation.

IncidentTemplate

incidentTemplate_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.

ItemIdentifier

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

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

notificationTargetItem_snsTopicArn :: Lens' NotificationTargetItem (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SNS topic.

RegionInfo

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

regionMapInputValue_sseKmsKeyId :: Lens' RegionMapInputValue (Maybe Text) Source #

The KMS key used to encrypt the data in your replication set.

RelatedItem

relatedItem_title :: Lens' RelatedItem (Maybe Text) Source #

The title of the related item.

RelatedItemsUpdate

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

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

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

responsePlanSummary_displayName :: Lens' ResponsePlanSummary (Maybe Text) Source #

The human readable name of the response plan. This can include spaces.

responsePlanSummary_arn :: Lens' ResponsePlanSummary Text Source #

The Amazon Resource Name (ARN) of the response plan.

responsePlanSummary_name :: Lens' ResponsePlanSummary Text Source #

The name of the response plan. This can't include spaces.

SsmAutomation

ssmAutomation_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

timelineEvent_eventData :: Lens' TimelineEvent Text Source #

A short description of the event.

timelineEvent_eventId :: Lens' TimelineEvent Text Source #

The ID of the timeline event.

timelineEvent_eventTime :: Lens' TimelineEvent UTCTime Source #

The time that the event occurred.

timelineEvent_eventType :: Lens' TimelineEvent Text Source #

The type of event that occurred. Currently Incident Manager supports only the Custom Event type.

timelineEvent_eventUpdatedTime :: Lens' TimelineEvent UTCTime Source #

The time that the timeline event was last updated.

timelineEvent_incidentRecordArn :: Lens' TimelineEvent Text Source #

The Amazon Resource Name (ARN) of the incident that the event occurred during.

TriggerDetails

triggerDetails_rawData :: Lens' TriggerDetails (Maybe Text) Source #

Raw data passed from either 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

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.