| 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 |
Amazonka.SSMContacts.Types
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _DataEncryptionException :: 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
- newtype AcceptCodeValidation where
- newtype AcceptType where
- AcceptType' { }
- pattern AcceptType_DELIVERED :: AcceptType
- pattern AcceptType_READ :: AcceptType
- newtype ActivationStatus where
- ActivationStatus' { }
- pattern ActivationStatus_ACTIVATED :: ActivationStatus
- pattern ActivationStatus_NOT_ACTIVATED :: ActivationStatus
- newtype ChannelType where
- ChannelType' { }
- pattern ChannelType_EMAIL :: ChannelType
- pattern ChannelType_SMS :: ChannelType
- pattern ChannelType_VOICE :: ChannelType
- newtype ContactType where
- ContactType' { }
- pattern ContactType_ESCALATION :: ContactType
- pattern ContactType_PERSONAL :: ContactType
- newtype ReceiptType where
- ReceiptType' { }
- pattern ReceiptType_DELIVERED :: ReceiptType
- pattern ReceiptType_ERROR :: ReceiptType
- pattern ReceiptType_READ :: ReceiptType
- pattern ReceiptType_SENT :: ReceiptType
- pattern ReceiptType_STOP :: ReceiptType
- data ChannelTargetInfo = ChannelTargetInfo' {}
- newChannelTargetInfo :: Text -> ChannelTargetInfo
- channelTargetInfo_retryIntervalInMinutes :: Lens' ChannelTargetInfo (Maybe Natural)
- channelTargetInfo_contactChannelId :: Lens' ChannelTargetInfo Text
- data Contact = Contact' {
- displayName :: Maybe Text
- contactArn :: Text
- alias :: Text
- type' :: ContactType
- newContact :: Text -> Text -> ContactType -> Contact
- contact_displayName :: Lens' Contact (Maybe Text)
- contact_contactArn :: Lens' Contact Text
- contact_alias :: Lens' Contact Text
- contact_type :: Lens' Contact ContactType
- data ContactChannel = ContactChannel' {}
- newContactChannel :: Text -> Text -> Text -> ContactChannelAddress -> ActivationStatus -> ContactChannel
- contactChannel_type :: Lens' ContactChannel (Maybe ChannelType)
- contactChannel_contactChannelArn :: Lens' ContactChannel Text
- contactChannel_contactArn :: Lens' ContactChannel Text
- contactChannel_name :: Lens' ContactChannel Text
- contactChannel_deliveryAddress :: Lens' ContactChannel ContactChannelAddress
- contactChannel_activationStatus :: Lens' ContactChannel ActivationStatus
- data ContactChannelAddress = ContactChannelAddress' {}
- newContactChannelAddress :: ContactChannelAddress
- contactChannelAddress_simpleAddress :: Lens' ContactChannelAddress (Maybe Text)
- data ContactTargetInfo = ContactTargetInfo' {
- contactId :: Maybe Text
- isEssential :: Bool
- newContactTargetInfo :: Bool -> ContactTargetInfo
- contactTargetInfo_contactId :: Lens' ContactTargetInfo (Maybe Text)
- contactTargetInfo_isEssential :: Lens' ContactTargetInfo Bool
- data Engagement = Engagement' {
- incidentId :: Maybe Text
- startTime :: Maybe POSIX
- stopTime :: Maybe POSIX
- engagementArn :: Text
- contactArn :: Text
- sender :: Text
- newEngagement :: Text -> Text -> Text -> Engagement
- engagement_incidentId :: Lens' Engagement (Maybe Text)
- engagement_startTime :: Lens' Engagement (Maybe UTCTime)
- engagement_stopTime :: Lens' Engagement (Maybe UTCTime)
- engagement_engagementArn :: Lens' Engagement Text
- engagement_contactArn :: Lens' Engagement Text
- engagement_sender :: Lens' Engagement Text
- data Page = Page' {
- deliveryTime :: Maybe POSIX
- incidentId :: Maybe Text
- readTime :: Maybe POSIX
- sentTime :: Maybe POSIX
- pageArn :: Text
- engagementArn :: Text
- contactArn :: Text
- sender :: Text
- newPage :: Text -> Text -> Text -> Text -> Page
- page_deliveryTime :: Lens' Page (Maybe UTCTime)
- page_incidentId :: Lens' Page (Maybe Text)
- page_readTime :: Lens' Page (Maybe UTCTime)
- page_sentTime :: Lens' Page (Maybe UTCTime)
- page_pageArn :: Lens' Page Text
- page_engagementArn :: Lens' Page Text
- page_contactArn :: Lens' Page Text
- page_sender :: Lens' Page Text
- data Plan = Plan' {}
- newPlan :: Plan
- plan_stages :: Lens' Plan [Stage]
- data Receipt = Receipt' {}
- newReceipt :: ReceiptType -> UTCTime -> Receipt
- receipt_contactChannelArn :: Lens' Receipt (Maybe Text)
- receipt_receiptInfo :: Lens' Receipt (Maybe Text)
- receipt_receiptType :: Lens' Receipt ReceiptType
- receipt_receiptTime :: Lens' Receipt UTCTime
- data Stage = Stage' {
- durationInMinutes :: Natural
- targets :: [Target]
- newStage :: Natural -> Stage
- stage_durationInMinutes :: Lens' Stage Natural
- stage_targets :: Lens' Stage [Target]
- data Tag = Tag' {}
- newTag :: Tag
- tag_key :: Lens' Tag (Maybe Text)
- tag_value :: Lens' Tag (Maybe Text)
- data Target = Target' {}
- newTarget :: Target
- target_channelTargetInfo :: Lens' Target (Maybe ChannelTargetInfo)
- target_contactTargetInfo :: Lens' Target (Maybe ContactTargetInfo)
- data TimeRange = TimeRange' {}
- newTimeRange :: TimeRange
- timeRange_endTime :: Lens' TimeRange (Maybe UTCTime)
- timeRange_startTime :: Lens' TimeRange (Maybe UTCTime)
Service Configuration
defaultService :: Service Source #
API version 2021-05-03 of the Amazon Systems Manager Incident Manager Contacts SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient access to perform this operation.
_ConflictException :: AsError a => Fold a ServiceError Source #
Updating or deleting a resource causes an inconsistent state.
_DataEncryptionException :: AsError a => Fold a ServiceError Source #
The operation failed to due an encryption key error.
_InternalServerException :: AsError a => Fold a ServiceError Source #
Unexpected error occurred while processing the request.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Request references a resource that doesn't exist.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
Request would cause a service quota to be exceeded.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an Amazon Web Services service.
AcceptCodeValidation
newtype AcceptCodeValidation Source #
Constructors
| AcceptCodeValidation' | |
Fields | |
Bundled Patterns
| pattern AcceptCodeValidation_ENFORCE :: AcceptCodeValidation | |
| pattern AcceptCodeValidation_IGNORE :: AcceptCodeValidation |
Instances
AcceptType
newtype AcceptType Source #
Constructors
| AcceptType' | |
Fields | |
Bundled Patterns
| pattern AcceptType_DELIVERED :: AcceptType | |
| pattern AcceptType_READ :: AcceptType |
Instances
ActivationStatus
newtype ActivationStatus Source #
Constructors
| ActivationStatus' | |
Fields | |
Bundled Patterns
| pattern ActivationStatus_ACTIVATED :: ActivationStatus | |
| pattern ActivationStatus_NOT_ACTIVATED :: ActivationStatus |
Instances
ChannelType
newtype ChannelType Source #
Constructors
| ChannelType' | |
Fields | |
Bundled Patterns
| pattern ChannelType_EMAIL :: ChannelType | |
| pattern ChannelType_SMS :: ChannelType | |
| pattern ChannelType_VOICE :: ChannelType |
Instances
ContactType
newtype ContactType Source #
Constructors
| ContactType' | |
Fields | |
Bundled Patterns
| pattern ContactType_ESCALATION :: ContactType | |
| pattern ContactType_PERSONAL :: ContactType |
Instances
ReceiptType
newtype ReceiptType Source #
Constructors
| ReceiptType' | |
Fields | |
Bundled Patterns
| pattern ReceiptType_DELIVERED :: ReceiptType | |
| pattern ReceiptType_ERROR :: ReceiptType | |
| pattern ReceiptType_READ :: ReceiptType | |
| pattern ReceiptType_SENT :: ReceiptType | |
| pattern ReceiptType_STOP :: ReceiptType |
Instances
ChannelTargetInfo
data ChannelTargetInfo Source #
Information about the contact channel that Incident Manager uses to engage the contact.
See: newChannelTargetInfo smart constructor.
Constructors
| ChannelTargetInfo' | |
Fields
| |
Instances
Create a value of ChannelTargetInfo 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:retryIntervalInMinutes:ChannelTargetInfo', channelTargetInfo_retryIntervalInMinutes - The number of minutes to wait to retry sending engagement in the case
the engagement initially fails.
$sel:contactChannelId:ChannelTargetInfo', channelTargetInfo_contactChannelId - The Amazon Resource Name (ARN) of the contact channel.
channelTargetInfo_retryIntervalInMinutes :: Lens' ChannelTargetInfo (Maybe Natural) Source #
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
channelTargetInfo_contactChannelId :: Lens' ChannelTargetInfo Text Source #
The Amazon Resource Name (ARN) of the contact channel.
Contact
A personal contact or escalation plan that Incident Manager engages during an incident.
See: newContact smart constructor.
Constructors
| Contact' | |
Fields
| |
Instances
| FromJSON Contact Source # | |
| Generic Contact Source # | |
| Read Contact Source # | |
| Show Contact Source # | |
| NFData Contact Source # | |
Defined in Amazonka.SSMContacts.Types.Contact | |
| Eq Contact Source # | |
| Hashable Contact Source # | |
Defined in Amazonka.SSMContacts.Types.Contact | |
| type Rep Contact Source # | |
Defined in Amazonka.SSMContacts.Types.Contact type Rep Contact = D1 ('MetaData "Contact" "Amazonka.SSMContacts.Types.Contact" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "Contact'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "contactArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContactType)))) | |
Arguments
| :: Text | |
| -> Text | |
| -> ContactType | |
| -> Contact |
Create a value of Contact 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:Contact', contact_displayName - The full name of the contact or escalation plan.
$sel:contactArn:Contact', contact_contactArn - The Amazon Resource Name (ARN) of the contact or escalation plan.
$sel:alias:Contact', contact_alias - The unique and identifiable alias of the contact or escalation plan.
$sel:type':Contact', contact_type - Refers to the type of contact. A single contact is type PERSONAL and
an escalation plan is type ESCALATION.
contact_displayName :: Lens' Contact (Maybe Text) Source #
The full name of the contact or escalation plan.
contact_contactArn :: Lens' Contact Text Source #
The Amazon Resource Name (ARN) of the contact or escalation plan.
contact_alias :: Lens' Contact Text Source #
The unique and identifiable alias of the contact or escalation plan.
contact_type :: Lens' Contact ContactType Source #
Refers to the type of contact. A single contact is type PERSONAL and
an escalation plan is type ESCALATION.
ContactChannel
data ContactChannel Source #
The method that Incident Manager uses to engage a contact.
See: newContactChannel smart constructor.
Constructors
| ContactChannel' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ContactChannelAddress | |
| -> ActivationStatus | |
| -> ContactChannel |
Create a value of ContactChannel 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':ContactChannel', contactChannel_type - The type of the contact channel. Incident Manager supports three contact
methods:
- SMS
- VOICE
$sel:contactChannelArn:ContactChannel', contactChannel_contactChannelArn - The Amazon Resource Name (ARN) of the contact channel.
$sel:contactArn:ContactChannel', contactChannel_contactArn - The ARN of the contact that contains the contact channel.
$sel:name:ContactChannel', contactChannel_name - The name of the contact channel.
$sel:deliveryAddress:ContactChannel', contactChannel_deliveryAddress - The details that Incident Manager uses when trying to engage the contact
channel.
$sel:activationStatus:ContactChannel', contactChannel_activationStatus - A Boolean value describing if the contact channel has been activated or
not. If the contact channel isn't activated, Incident Manager can't
engage the contact through it.
contactChannel_type :: Lens' ContactChannel (Maybe ChannelType) Source #
The type of the contact channel. Incident Manager supports three contact methods:
- SMS
- VOICE
contactChannel_contactChannelArn :: Lens' ContactChannel Text Source #
The Amazon Resource Name (ARN) of the contact channel.
contactChannel_contactArn :: Lens' ContactChannel Text Source #
The ARN of the contact that contains the contact channel.
contactChannel_name :: Lens' ContactChannel Text Source #
The name of the contact channel.
contactChannel_deliveryAddress :: Lens' ContactChannel ContactChannelAddress Source #
The details that Incident Manager uses when trying to engage the contact channel.
contactChannel_activationStatus :: Lens' ContactChannel ActivationStatus Source #
A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.
ContactChannelAddress
data ContactChannelAddress Source #
The details that Incident Manager uses when trying to engage the contact channel.
See: newContactChannelAddress smart constructor.
Constructors
| ContactChannelAddress' | |
Fields
| |
Instances
newContactChannelAddress :: ContactChannelAddress Source #
Create a value of ContactChannelAddress 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:simpleAddress:ContactChannelAddress', contactChannelAddress_simpleAddress - The format is dependent on the type of the contact channel. The
following are the expected formats:
- SMS - '+' followed by the country code and phone number
- VOICE - '+' followed by the country code and phone number
- EMAIL - any standard email format
contactChannelAddress_simpleAddress :: Lens' ContactChannelAddress (Maybe Text) Source #
The format is dependent on the type of the contact channel. The following are the expected formats:
- SMS - '+' followed by the country code and phone number
- VOICE - '+' followed by the country code and phone number
- EMAIL - any standard email format
ContactTargetInfo
data ContactTargetInfo Source #
The contact that Incident Manager is engaging during an incident.
See: newContactTargetInfo smart constructor.
Constructors
| ContactTargetInfo' | |
Fields
| |
Instances
Arguments
| :: Bool | |
| -> ContactTargetInfo |
Create a value of ContactTargetInfo 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:contactId:ContactTargetInfo', contactTargetInfo_contactId - The Amazon Resource Name (ARN) of the contact.
$sel:isEssential:ContactTargetInfo', contactTargetInfo_isEssential - A Boolean value determining if the contact's acknowledgement stops the
progress of stages in the plan.
contactTargetInfo_contactId :: Lens' ContactTargetInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) of the contact.
contactTargetInfo_isEssential :: Lens' ContactTargetInfo Bool Source #
A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
Engagement
data Engagement Source #
Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.
See: newEngagement smart constructor.
Constructors
| Engagement' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Engagement |
Create a value of Engagement 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:incidentId:Engagement', engagement_incidentId - The ARN of the incident that's engaging the contact.
$sel:startTime:Engagement', engagement_startTime - The time that the engagement began.
$sel:stopTime:Engagement', engagement_stopTime - The time that the engagement ended.
$sel:engagementArn:Engagement', engagement_engagementArn - The Amazon Resource Name (ARN) of the engagement.
$sel:contactArn:Engagement', engagement_contactArn - The ARN of the escalation plan or contact that Incident Manager is
engaging.
$sel:sender:Engagement', engagement_sender - The user that started the engagement.
engagement_incidentId :: Lens' Engagement (Maybe Text) Source #
The ARN of the incident that's engaging the contact.
engagement_startTime :: Lens' Engagement (Maybe UTCTime) Source #
The time that the engagement began.
engagement_stopTime :: Lens' Engagement (Maybe UTCTime) Source #
The time that the engagement ended.
engagement_engagementArn :: Lens' Engagement Text Source #
The Amazon Resource Name (ARN) of the engagement.
engagement_contactArn :: Lens' Engagement Text Source #
The ARN of the escalation plan or contact that Incident Manager is engaging.
engagement_sender :: Lens' Engagement Text Source #
The user that started the engagement.
Page
Incident Manager engaging a contact's contact channel.
See: newPage smart constructor.
Constructors
| Page' | |
Fields
| |
Instances
Create a value of Page 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:deliveryTime:Page', page_deliveryTime - The time the message was delivered to the contact channel.
$sel:incidentId:Page', page_incidentId - The ARN of the incident that's engaging the contact channel.
$sel:readTime:Page', page_readTime - The time that the contact channel acknowledged engagement.
$sel:sentTime:Page', page_sentTime - The time that Incident Manager engaged the contact channel.
$sel:pageArn:Page', page_pageArn - The Amazon Resource Name (ARN) of the page to the contact channel.
$sel:engagementArn:Page', page_engagementArn - The ARN of the engagement that this page is part of.
$sel:contactArn:Page', page_contactArn - The ARN of the contact that Incident Manager is engaging.
$sel:sender:Page', page_sender - The user that started the engagement.
page_deliveryTime :: Lens' Page (Maybe UTCTime) Source #
The time the message was delivered to the contact channel.
page_incidentId :: Lens' Page (Maybe Text) Source #
The ARN of the incident that's engaging the contact channel.
page_readTime :: Lens' Page (Maybe UTCTime) Source #
The time that the contact channel acknowledged engagement.
page_sentTime :: Lens' Page (Maybe UTCTime) Source #
The time that Incident Manager engaged the contact channel.
page_pageArn :: Lens' Page Text Source #
The Amazon Resource Name (ARN) of the page to the contact channel.
page_contactArn :: Lens' Page Text Source #
The ARN of the contact that Incident Manager is engaging.
Plan
The stages that an escalation plan or engagement plan engages contacts and contact methods in.
See: newPlan smart constructor.
Constructors
| Plan' | |
Instances
| FromJSON Plan Source # | |
| ToJSON Plan Source # | |
Defined in Amazonka.SSMContacts.Types.Plan | |
| Generic Plan Source # | |
| Read Plan Source # | |
| Show Plan Source # | |
| NFData Plan Source # | |
Defined in Amazonka.SSMContacts.Types.Plan | |
| Eq Plan Source # | |
| Hashable Plan Source # | |
Defined in Amazonka.SSMContacts.Types.Plan | |
| type Rep Plan Source # | |
Defined in Amazonka.SSMContacts.Types.Plan | |
Create a value of Plan 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:stages:Plan', plan_stages - A list of stages that the escalation plan or engagement plan uses to
engage contacts and contact methods.
plan_stages :: Lens' Plan [Stage] Source #
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
Receipt
Records events during an engagement.
See: newReceipt smart constructor.
Constructors
| Receipt' | |
Fields
| |
Instances
| FromJSON Receipt Source # | |
| Generic Receipt Source # | |
| Read Receipt Source # | |
| Show Receipt Source # | |
| NFData Receipt Source # | |
Defined in Amazonka.SSMContacts.Types.Receipt | |
| Eq Receipt Source # | |
| Hashable Receipt Source # | |
Defined in Amazonka.SSMContacts.Types.Receipt | |
| type Rep Receipt Source # | |
Defined in Amazonka.SSMContacts.Types.Receipt type Rep Receipt = D1 ('MetaData "Receipt" "Amazonka.SSMContacts.Types.Receipt" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "Receipt'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contactChannelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "receiptInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "receiptType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReceiptType) :*: S1 ('MetaSel ('Just "receiptTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))) | |
Create a value of Receipt 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:contactChannelArn:Receipt', receipt_contactChannelArn - The Amazon Resource Name (ARN) of the contact channel Incident Manager
engaged.
$sel:receiptInfo:Receipt', receipt_receiptInfo - Information provided during the page acknowledgement.
$sel:receiptType:Receipt', receipt_receiptType - The type follows the engagement cycle, SENT, DELIVERED, and READ.
$sel:receiptTime:Receipt', receipt_receiptTime - The time receipt was SENT, DELIVERED, or READ.
receipt_contactChannelArn :: Lens' Receipt (Maybe Text) Source #
The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.
receipt_receiptInfo :: Lens' Receipt (Maybe Text) Source #
Information provided during the page acknowledgement.
receipt_receiptType :: Lens' Receipt ReceiptType Source #
The type follows the engagement cycle, SENT, DELIVERED, and READ.
Stage
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
See: newStage smart constructor.
Constructors
| Stage' | |
Fields
| |
Instances
| FromJSON Stage Source # | |
| ToJSON Stage Source # | |
Defined in Amazonka.SSMContacts.Types.Stage | |
| Generic Stage Source # | |
| Read Stage Source # | |
| Show Stage Source # | |
| NFData Stage Source # | |
Defined in Amazonka.SSMContacts.Types.Stage | |
| Eq Stage Source # | |
| Hashable Stage Source # | |
Defined in Amazonka.SSMContacts.Types.Stage | |
| type Rep Stage Source # | |
Defined in Amazonka.SSMContacts.Types.Stage type Rep Stage = D1 ('MetaData "Stage" "Amazonka.SSMContacts.Types.Stage" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "Stage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "durationInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Target]))) | |
Create a value of Stage 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:durationInMinutes:Stage', stage_durationInMinutes - The time to wait until beginning the next stage. The duration can only
be set to 0 if a target is specified.
$sel:targets:Stage', stage_targets - The contacts or contact methods that the escalation plan or engagement
plan is engaging.
stage_durationInMinutes :: Lens' Stage Natural Source #
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
stage_targets :: Lens' Stage [Target] Source #
The contacts or contact methods that the escalation plan or engagement plan is engaging.
Tag
A container of a key-value name pair.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.SSMContacts.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.SSMContacts.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.SSMContacts.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.SSMContacts.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.SSMContacts.Types.Tag" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Tag 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:key:Tag', tag_key - Name of the object key.
$sel:value:Tag', tag_value - Value of the tag.
Target
The contact or contact channel that's being engaged.
See: newTarget smart constructor.
Constructors
| Target' | |
Fields
| |
Instances
| FromJSON Target Source # | |
| ToJSON Target Source # | |
Defined in Amazonka.SSMContacts.Types.Target | |
| Generic Target Source # | |
| Read Target Source # | |
| Show Target Source # | |
| NFData Target Source # | |
Defined in Amazonka.SSMContacts.Types.Target | |
| Eq Target Source # | |
| Hashable Target Source # | |
Defined in Amazonka.SSMContacts.Types.Target | |
| type Rep Target Source # | |
Defined in Amazonka.SSMContacts.Types.Target type Rep Target = D1 ('MetaData "Target" "Amazonka.SSMContacts.Types.Target" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "Target'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelTargetInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelTargetInfo)) :*: S1 ('MetaSel ('Just "contactTargetInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContactTargetInfo)))) | |
Create a value of Target 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:channelTargetInfo:Target', target_channelTargetInfo - Information about the contact channel Incident Manager is engaging.
$sel:contactTargetInfo:Target', target_contactTargetInfo - Information about the contact that Incident Manager is engaging.
target_channelTargetInfo :: Lens' Target (Maybe ChannelTargetInfo) Source #
Information about the contact channel Incident Manager is engaging.
target_contactTargetInfo :: Lens' Target (Maybe ContactTargetInfo) Source #
Information about the contact that Incident Manager is engaging.
TimeRange
A range of between two set times
See: newTimeRange smart constructor.
Constructors
| TimeRange' | |
Instances
| ToJSON TimeRange Source # | |
Defined in Amazonka.SSMContacts.Types.TimeRange | |
| Generic TimeRange Source # | |
| Read TimeRange Source # | |
| Show TimeRange Source # | |
| NFData TimeRange Source # | |
Defined in Amazonka.SSMContacts.Types.TimeRange | |
| Eq TimeRange Source # | |
| Hashable TimeRange Source # | |
Defined in Amazonka.SSMContacts.Types.TimeRange | |
| type Rep TimeRange Source # | |
Defined in Amazonka.SSMContacts.Types.TimeRange type Rep TimeRange = D1 ('MetaData "TimeRange" "Amazonka.SSMContacts.Types.TimeRange" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "TimeRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) | |
newTimeRange :: TimeRange Source #
Create a value of TimeRange 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:endTime:TimeRange', timeRange_endTime - The end of the time range.
$sel:startTime:TimeRange', timeRange_startTime - The start of the time range.