Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- AcceptPage
- ActivateContactChannel
- CreateContact
- CreateContactChannel
- DeactivateContactChannel
- DeleteContact
- DeleteContactChannel
- DescribeEngagement
- DescribePage
- GetContact
- GetContactChannel
- GetContactPolicy
- ListContactChannels (Paginated)
- ListContacts (Paginated)
- ListEngagements (Paginated)
- ListPageReceipts (Paginated)
- ListPagesByContact (Paginated)
- ListPagesByEngagement (Paginated)
- ListTagsForResource
- PutContactPolicy
- SendActivationCode
- StartEngagement
- StopEngagement
- TagResource
- UntagResource
- UpdateContact
- UpdateContactChannel
- Types
Derived from API version 2021-05-03
of the AWS service descriptions, licensed under Apache 2.0.
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _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
- data AcceptPage = AcceptPage' (Maybe AcceptCodeValidation) (Maybe Text) (Maybe Text) Text AcceptType Text
- newAcceptPage :: Text -> AcceptType -> Text -> AcceptPage
- data AcceptPageResponse = AcceptPageResponse' Int
- newAcceptPageResponse :: Int -> AcceptPageResponse
- data ActivateContactChannel = ActivateContactChannel' Text Text
- newActivateContactChannel :: Text -> Text -> ActivateContactChannel
- data ActivateContactChannelResponse = ActivateContactChannelResponse' Int
- newActivateContactChannelResponse :: Int -> ActivateContactChannelResponse
- data CreateContact = CreateContact' (Maybe Text) (Maybe Text) (Maybe [Tag]) Text ContactType Plan
- newCreateContact :: Text -> ContactType -> Plan -> CreateContact
- data CreateContactResponse = CreateContactResponse' Int Text
- newCreateContactResponse :: Int -> Text -> CreateContactResponse
- data CreateContactChannel = CreateContactChannel' (Maybe Bool) (Maybe Text) Text Text ChannelType ContactChannelAddress
- newCreateContactChannel :: Text -> Text -> ChannelType -> ContactChannelAddress -> CreateContactChannel
- data CreateContactChannelResponse = CreateContactChannelResponse' Int Text
- newCreateContactChannelResponse :: Int -> Text -> CreateContactChannelResponse
- data DeactivateContactChannel = DeactivateContactChannel' Text
- newDeactivateContactChannel :: Text -> DeactivateContactChannel
- data DeactivateContactChannelResponse = DeactivateContactChannelResponse' Int
- newDeactivateContactChannelResponse :: Int -> DeactivateContactChannelResponse
- data DeleteContact = DeleteContact' Text
- newDeleteContact :: Text -> DeleteContact
- data DeleteContactResponse = DeleteContactResponse' Int
- newDeleteContactResponse :: Int -> DeleteContactResponse
- data DeleteContactChannel = DeleteContactChannel' Text
- newDeleteContactChannel :: Text -> DeleteContactChannel
- data DeleteContactChannelResponse = DeleteContactChannelResponse' Int
- newDeleteContactChannelResponse :: Int -> DeleteContactChannelResponse
- data DescribeEngagement = DescribeEngagement' Text
- newDescribeEngagement :: Text -> DescribeEngagement
- data DescribeEngagementResponse = DescribeEngagementResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) Int Text Text Text Text Text
- newDescribeEngagementResponse :: Int -> Text -> Text -> Text -> Text -> Text -> DescribeEngagementResponse
- data DescribePage = DescribePage' Text
- newDescribePage :: Text -> DescribePage
- data DescribePageResponse = DescribePageResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) Int Text Text Text Text Text Text
- newDescribePageResponse :: Int -> Text -> Text -> Text -> Text -> Text -> Text -> DescribePageResponse
- data GetContact = GetContact' Text
- newGetContact :: Text -> GetContact
- data GetContactResponse = GetContactResponse' (Maybe Text) Int Text Text ContactType Plan
- newGetContactResponse :: Int -> Text -> Text -> ContactType -> Plan -> GetContactResponse
- data GetContactChannel = GetContactChannel' Text
- newGetContactChannel :: Text -> GetContactChannel
- data GetContactChannelResponse = GetContactChannelResponse' (Maybe ActivationStatus) Int Text Text Text ChannelType ContactChannelAddress
- newGetContactChannelResponse :: Int -> Text -> Text -> Text -> ChannelType -> ContactChannelAddress -> GetContactChannelResponse
- data GetContactPolicy = GetContactPolicy' Text
- newGetContactPolicy :: Text -> GetContactPolicy
- data GetContactPolicyResponse = GetContactPolicyResponse' (Maybe Text) (Maybe Text) Int
- newGetContactPolicyResponse :: Int -> GetContactPolicyResponse
- data ListContactChannels = ListContactChannels' (Maybe Natural) (Maybe Text) Text
- newListContactChannels :: Text -> ListContactChannels
- data ListContactChannelsResponse = ListContactChannelsResponse' (Maybe Text) Int [ContactChannel]
- newListContactChannelsResponse :: Int -> ListContactChannelsResponse
- data ListContacts = ListContacts' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ContactType)
- newListContacts :: ListContacts
- data ListContactsResponse = ListContactsResponse' (Maybe [Contact]) (Maybe Text) Int
- newListContactsResponse :: Int -> ListContactsResponse
- data ListEngagements = ListEngagements' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe TimeRange)
- newListEngagements :: ListEngagements
- data ListEngagementsResponse = ListEngagementsResponse' (Maybe Text) Int [Engagement]
- newListEngagementsResponse :: Int -> ListEngagementsResponse
- data ListPageReceipts = ListPageReceipts' (Maybe Natural) (Maybe Text) Text
- newListPageReceipts :: Text -> ListPageReceipts
- data ListPageReceiptsResponse = ListPageReceiptsResponse' (Maybe Text) (Maybe [Receipt]) Int
- newListPageReceiptsResponse :: Int -> ListPageReceiptsResponse
- data ListPagesByContact = ListPagesByContact' (Maybe Natural) (Maybe Text) Text
- newListPagesByContact :: Text -> ListPagesByContact
- data ListPagesByContactResponse = ListPagesByContactResponse' (Maybe Text) Int [Page]
- newListPagesByContactResponse :: Int -> ListPagesByContactResponse
- data ListPagesByEngagement = ListPagesByEngagement' (Maybe Natural) (Maybe Text) Text
- newListPagesByEngagement :: Text -> ListPagesByEngagement
- data ListPagesByEngagementResponse = ListPagesByEngagementResponse' (Maybe Text) Int [Page]
- newListPagesByEngagementResponse :: Int -> ListPagesByEngagementResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutContactPolicy = PutContactPolicy' Text Text
- newPutContactPolicy :: Text -> Text -> PutContactPolicy
- data PutContactPolicyResponse = PutContactPolicyResponse' Int
- newPutContactPolicyResponse :: Int -> PutContactPolicyResponse
- data SendActivationCode = SendActivationCode' Text
- newSendActivationCode :: Text -> SendActivationCode
- data SendActivationCodeResponse = SendActivationCodeResponse' Int
- newSendActivationCodeResponse :: Int -> SendActivationCodeResponse
- data StartEngagement = StartEngagement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text Text
- newStartEngagement :: Text -> Text -> Text -> Text -> StartEngagement
- data StartEngagementResponse = StartEngagementResponse' Int Text
- newStartEngagementResponse :: Int -> Text -> StartEngagementResponse
- data StopEngagement = StopEngagement' (Maybe Text) Text
- newStopEngagement :: Text -> StopEngagement
- data StopEngagementResponse = StopEngagementResponse' Int
- newStopEngagementResponse :: Int -> StopEngagementResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateContact = UpdateContact' (Maybe Text) (Maybe Plan) Text
- newUpdateContact :: Text -> UpdateContact
- data UpdateContactResponse = UpdateContactResponse' Int
- newUpdateContactResponse :: Int -> UpdateContactResponse
- data UpdateContactChannel = UpdateContactChannel' (Maybe ContactChannelAddress) (Maybe Text) Text
- newUpdateContactChannel :: Text -> UpdateContactChannel
- data UpdateContactChannelResponse = UpdateContactChannelResponse' Int
- newUpdateContactChannelResponse :: Int -> UpdateContactChannelResponse
- 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' (Maybe Natural) Text
- newChannelTargetInfo :: Text -> ChannelTargetInfo
- data Contact = Contact' (Maybe Text) Text Text ContactType
- newContact :: Text -> Text -> ContactType -> Contact
- data ContactChannel = ContactChannel' (Maybe ChannelType) Text Text Text ContactChannelAddress ActivationStatus
- newContactChannel :: Text -> Text -> Text -> ContactChannelAddress -> ActivationStatus -> ContactChannel
- data ContactChannelAddress = ContactChannelAddress' (Maybe Text)
- newContactChannelAddress :: ContactChannelAddress
- data ContactTargetInfo = ContactTargetInfo' (Maybe Text) Bool
- newContactTargetInfo :: Bool -> ContactTargetInfo
- data Engagement = Engagement' (Maybe Text) (Maybe POSIX) (Maybe POSIX) Text Text Text
- newEngagement :: Text -> Text -> Text -> Engagement
- data Page = Page' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) Text Text Text Text
- newPage :: Text -> Text -> Text -> Text -> Page
- data Plan = Plan' [Stage]
- newPlan :: Plan
- data Receipt = Receipt' (Maybe Text) (Maybe Text) ReceiptType POSIX
- newReceipt :: ReceiptType -> UTCTime -> Receipt
- data Stage = Stage' Natural [Target]
- newStage :: Natural -> Stage
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data Target = Target' (Maybe ChannelTargetInfo) (Maybe ContactTargetInfo)
- newTarget :: Target
- data TimeRange = TimeRange' (Maybe POSIX) (Maybe POSIX)
- newTimeRange :: TimeRange
Service Configuration
defaultService :: Service Source #
API version 2021-05-03
of the Amazon Systems Manager Incident Manager Contacts SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SSMContacts
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient access to perform this operation.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Updating or deleting a resource causes an inconsistent state.
DataEncryptionException
_DataEncryptionException :: AsError a => Fold a ServiceError Source #
The operation failed to due an encryption key error.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Unexpected error occurred while processing the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Request references a resource that doesn't exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
Request would cause a service quota to be exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an Amazon Web Services service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AcceptPage
data AcceptPage Source #
See: newAcceptPage
smart constructor.
Instances
:: Text | |
-> AcceptType | |
-> Text | |
-> AcceptPage |
Create a value of AcceptPage
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:acceptCodeValidation:AcceptPage'
, acceptPage_acceptCodeValidation
- An optional field that Incident Manager uses to ENFORCE
AcceptCode
validation when acknowledging an page. Acknowledgement can occur by
replying to a page, or when entering the AcceptCode in the console.
Enforcing AcceptCode validation causes Incident Manager to verify that
the code entered by the user matches the code sent by Incident Manager
with the page.
Incident Manager can also IGNORE
AcceptCode
validation. Ignoring
AcceptCode
validation causes Incident Manager to accept any value
entered for the AcceptCode
.
AcceptPage
, acceptPage_contactChannelId
- The ARN of the contact channel.
$sel:note:AcceptPage'
, acceptPage_note
- Information provided by the user when the user acknowledges the page.
$sel:pageId:AcceptPage'
, acceptPage_pageId
- The Amazon Resource Name (ARN) of the engagement to a contact channel.
$sel:acceptType:AcceptPage'
, acceptPage_acceptType
- The type indicates if the page was DELIVERED
or READ
.
$sel:acceptCode:AcceptPage'
, acceptPage_acceptCode
- The accept code is a 6-digit code used to acknowledge the page.
data AcceptPageResponse Source #
See: newAcceptPageResponse
smart constructor.
Instances
newAcceptPageResponse Source #
Create a value of AcceptPageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AcceptPageResponse'
, acceptPageResponse_httpStatus
- The response's http status code.
ActivateContactChannel
data ActivateContactChannel Source #
See: newActivateContactChannel
smart constructor.
Instances
newActivateContactChannel Source #
:: Text | |
-> Text | |
-> ActivateContactChannel |
Create a value of ActivateContactChannel
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:
ActivateContactChannel
, activateContactChannel_contactChannelId
- The Amazon Resource Name (ARN) of the contact channel.
$sel:activationCode:ActivateContactChannel'
, activateContactChannel_activationCode
- The code sent to the contact channel when it was created in the contact.
data ActivateContactChannelResponse Source #
See: newActivateContactChannelResponse
smart constructor.
Instances
Generic ActivateContactChannelResponse Source # | |
Read ActivateContactChannelResponse Source # | |
Show ActivateContactChannelResponse Source # | |
Defined in Amazonka.SSMContacts.ActivateContactChannel | |
NFData ActivateContactChannelResponse Source # | |
Defined in Amazonka.SSMContacts.ActivateContactChannel rnf :: ActivateContactChannelResponse -> () # | |
Eq ActivateContactChannelResponse Source # | |
type Rep ActivateContactChannelResponse Source # | |
Defined in Amazonka.SSMContacts.ActivateContactChannel type Rep ActivateContactChannelResponse = D1 ('MetaData "ActivateContactChannelResponse" "Amazonka.SSMContacts.ActivateContactChannel" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "ActivateContactChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newActivateContactChannelResponse Source #
Create a value of ActivateContactChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ActivateContactChannelResponse'
, activateContactChannelResponse_httpStatus
- The response's http status code.
CreateContact
data CreateContact Source #
See: newCreateContact
smart constructor.
CreateContact' (Maybe Text) (Maybe Text) (Maybe [Tag]) Text ContactType Plan |
Instances
Create a value of CreateContact
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:
CreateContact
, createContact_displayName
- The full name of the contact or escalation plan.
$sel:idempotencyToken:CreateContact'
, createContact_idempotencyToken
- A token ensuring that the operation is called only once with the
specified details.
$sel:tags:CreateContact'
, createContact_tags
- Adds a tag to the target. You can only tag resources created in the
first Region of your replication set.
CreateContact
, createContact_alias
- The short name to quickly identify a contact or escalation plan. The
contact alias must be unique and identifiable.
CreateContact
, createContact_type
- To create an escalation plan use ESCALATION
. To create a contact use
PERSONAL
.
$sel:plan:CreateContact'
, createContact_plan
- A list of stages. A contact has an engagement plan with stages that
contact specified contact channels. An escalation plan uses stages that
contact specified contacts.
data CreateContactResponse Source #
See: newCreateContactResponse
smart constructor.
Instances
newCreateContactResponse Source #
Create a value of CreateContactResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateContactResponse'
, createContactResponse_httpStatus
- The response's http status code.
CreateContactResponse
, createContactResponse_contactArn
- The Amazon Resource Name (ARN) of the created contact or escalation
plan.
CreateContactChannel
data CreateContactChannel Source #
See: newCreateContactChannel
smart constructor.
Instances
newCreateContactChannel Source #
:: Text | |
-> Text | |
-> ChannelType | |
-> ContactChannelAddress | |
-> CreateContactChannel |
Create a value of CreateContactChannel
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:deferActivation:CreateContactChannel'
, createContactChannel_deferActivation
- If you want to activate the channel at a later time, you can choose to
defer activation. Incident Manager can't engage your contact channel
until it has been activated.
$sel:idempotencyToken:CreateContactChannel'
, createContactChannel_idempotencyToken
- A token ensuring that the operation is called only once with the
specified details.
CreateContactChannel
, createContactChannel_contactId
- The Amazon Resource Name (ARN) of the contact you are adding the contact
channel to.
CreateContactChannel
, createContactChannel_name
- The name of the contact channel.
CreateContactChannel
, createContactChannel_type
- Incident Manager supports three types of contact channels:
SMS
VOICE
EMAIL
CreateContactChannel
, createContactChannel_deliveryAddress
- The details that Incident Manager uses when trying to engage the contact
channel. 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
data CreateContactChannelResponse Source #
See: newCreateContactChannelResponse
smart constructor.
Instances
newCreateContactChannelResponse Source #
:: Int | |
-> Text | |
-> CreateContactChannelResponse |
Create a value of CreateContactChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateContactChannelResponse'
, createContactChannelResponse_httpStatus
- The response's http status code.
CreateContactChannelResponse
, createContactChannelResponse_contactChannelArn
- The Amazon Resource Name (ARN) of the contact channel.
DeactivateContactChannel
data DeactivateContactChannel Source #
See: newDeactivateContactChannel
smart constructor.
Instances
newDeactivateContactChannel Source #
Create a value of DeactivateContactChannel
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:
DeactivateContactChannel
, deactivateContactChannel_contactChannelId
- The Amazon Resource Name (ARN) of the contact channel you're
deactivating.
data DeactivateContactChannelResponse Source #
See: newDeactivateContactChannelResponse
smart constructor.
Instances
Generic DeactivateContactChannelResponse Source # | |
Read DeactivateContactChannelResponse Source # | |
Show DeactivateContactChannelResponse Source # | |
NFData DeactivateContactChannelResponse Source # | |
Defined in Amazonka.SSMContacts.DeactivateContactChannel rnf :: DeactivateContactChannelResponse -> () # | |
Eq DeactivateContactChannelResponse Source # | |
type Rep DeactivateContactChannelResponse Source # | |
Defined in Amazonka.SSMContacts.DeactivateContactChannel type Rep DeactivateContactChannelResponse = D1 ('MetaData "DeactivateContactChannelResponse" "Amazonka.SSMContacts.DeactivateContactChannel" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "DeactivateContactChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeactivateContactChannelResponse Source #
Create a value of DeactivateContactChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeactivateContactChannelResponse'
, deactivateContactChannelResponse_httpStatus
- The response's http status code.
DeleteContact
data DeleteContact Source #
See: newDeleteContact
smart constructor.
Instances
Create a value of DeleteContact
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:
DeleteContact
, deleteContact_contactId
- The Amazon Resource Name (ARN) of the contact that you're deleting.
data DeleteContactResponse Source #
See: newDeleteContactResponse
smart constructor.
Instances
newDeleteContactResponse Source #
Create a value of DeleteContactResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteContactResponse'
, deleteContactResponse_httpStatus
- The response's http status code.
DeleteContactChannel
data DeleteContactChannel Source #
See: newDeleteContactChannel
smart constructor.
Instances
newDeleteContactChannel Source #
Create a value of DeleteContactChannel
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:
DeleteContactChannel
, deleteContactChannel_contactChannelId
- The Amazon Resource Name (ARN) of the contact channel.
data DeleteContactChannelResponse Source #
See: newDeleteContactChannelResponse
smart constructor.
Instances
newDeleteContactChannelResponse Source #
Create a value of DeleteContactChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteContactChannelResponse'
, deleteContactChannelResponse_httpStatus
- The response's http status code.
DescribeEngagement
data DescribeEngagement Source #
See: newDescribeEngagement
smart constructor.
Instances
newDescribeEngagement Source #
Create a value of DescribeEngagement
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:engagementId:DescribeEngagement'
, describeEngagement_engagementId
- The Amazon Resource Name (ARN) of the engagement you want the details
of.
data DescribeEngagementResponse Source #
See: newDescribeEngagementResponse
smart constructor.
DescribeEngagementResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) Int Text Text Text Text Text |
Instances
newDescribeEngagementResponse Source #
Create a value of DescribeEngagementResponse
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:
DescribeEngagementResponse
, describeEngagementResponse_incidentId
- The ARN of the incident in which the engagement occurred.
$sel:publicContent:DescribeEngagementResponse'
, describeEngagementResponse_publicContent
- The insecure content of the message that was sent to the contact. Use
this field for engagements to SMS
.
$sel:publicSubject:DescribeEngagementResponse'
, describeEngagementResponse_publicSubject
- The insecure subject of the message that was sent to the contact. Use
this field for engagements to SMS
.
DescribeEngagementResponse
, describeEngagementResponse_startTime
- The time that the engagement started.
DescribeEngagementResponse
, describeEngagementResponse_stopTime
- The time that the engagement ended.
$sel:httpStatus:DescribeEngagementResponse'
, describeEngagementResponse_httpStatus
- The response's http status code.
DescribeEngagementResponse
, describeEngagementResponse_contactArn
- The ARN of the escalation plan or contacts involved in the engagement.
DescribeEngagementResponse
, describeEngagementResponse_engagementArn
- The ARN of the engagement.
DescribeEngagementResponse
, describeEngagementResponse_sender
- The user that started the engagement.
$sel:subject:DescribeEngagementResponse'
, describeEngagementResponse_subject
- The secure subject of the message that was sent to the contact. Use this
field for engagements to VOICE
and EMAIL
.
$sel:content:DescribeEngagementResponse'
, describeEngagementResponse_content
- The secure content of the message that was sent to the contact. Use this
field for engagements to VOICE
and EMAIL
.
DescribePage
data DescribePage Source #
See: newDescribePage
smart constructor.
Instances
Create a value of DescribePage
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:pageId:DescribePage'
, describePage_pageId
- The ID of the engagement to a contact channel.
data DescribePageResponse Source #
See: newDescribePageResponse
smart constructor.
DescribePageResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) Int Text Text Text Text Text Text |
Instances
newDescribePageResponse Source #
Create a value of DescribePageResponse
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:
DescribePageResponse
, describePageResponse_deliveryTime
- The time that the contact channel received the engagement.
DescribePageResponse
, describePageResponse_incidentId
- The ARN of the incident that engaged the contact channel.
$sel:publicContent:DescribePageResponse'
, describePageResponse_publicContent
- The insecure content of the message that was sent to the contact. Use
this field for engagements to SMS
.
$sel:publicSubject:DescribePageResponse'
, describePageResponse_publicSubject
- The insecure subject of the message that was sent to the contact. Use
this field for engagements to SMS
.
DescribePageResponse
, describePageResponse_readTime
- The time that the contact channel acknowledged the engagement.
DescribePageResponse
, describePageResponse_sentTime
- The time the engagement was sent to the contact channel.
$sel:httpStatus:DescribePageResponse'
, describePageResponse_httpStatus
- The response's http status code.
DescribePageResponse
, describePageResponse_pageArn
- The Amazon Resource Name (ARN) of the engagement to a contact channel.
DescribePageResponse
, describePageResponse_engagementArn
- The ARN of the engagement that engaged the contact channel.
DescribePageResponse
, describePageResponse_contactArn
- The ARN of the contact that was engaged.
DescribePageResponse
, describePageResponse_sender
- The user that started the engagement.
$sel:subject:DescribePageResponse'
, describePageResponse_subject
- The secure subject of the message that was sent to the contact. Use this
field for engagements to VOICE
and EMAIL
.
$sel:content:DescribePageResponse'
, describePageResponse_content
- The secure content of the message that was sent to the contact. Use this
field for engagements to VOICE
and EMAIL
.
GetContact
data GetContact Source #
See: newGetContact
smart constructor.
Instances
:: Text | |
-> GetContact |
Create a value of GetContact
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:
GetContact
, getContact_contactId
- The Amazon Resource Name (ARN) of the contact or escalation plan.
data GetContactResponse Source #
See: newGetContactResponse
smart constructor.
Instances
newGetContactResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> ContactType | |
-> Plan | |
-> GetContactResponse |
Create a value of GetContactResponse
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:
GetContactResponse
, getContactResponse_displayName
- The full name of the contact or escalation plan.
$sel:httpStatus:GetContactResponse'
, getContactResponse_httpStatus
- The response's http status code.
GetContactResponse
, getContactResponse_contactArn
- The ARN of the contact or escalation plan.
GetContactResponse
, getContactResponse_alias
- The alias of the contact or escalation plan. The alias is unique and
identifiable.
GetContactResponse
, getContactResponse_type
- The type of contact, either PERSONAL
or ESCALATION
.
$sel:plan:GetContactResponse'
, getContactResponse_plan
- Details about the specific timing or stages and targets of the
escalation plan or engagement plan.
GetContactChannel
data GetContactChannel Source #
See: newGetContactChannel
smart constructor.
Instances
Create a value of GetContactChannel
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:
GetContactChannel
, getContactChannel_contactChannelId
- The Amazon Resource Name (ARN) of the contact channel you want
information about.
data GetContactChannelResponse Source #
See: newGetContactChannelResponse
smart constructor.
GetContactChannelResponse' (Maybe ActivationStatus) Int Text Text Text ChannelType ContactChannelAddress |
Instances
newGetContactChannelResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> ChannelType | |
-> ContactChannelAddress | |
-> GetContactChannelResponse |
Create a value of GetContactChannelResponse
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:
GetContactChannelResponse
, getContactChannelResponse_activationStatus
- A Boolean value indicating if the contact channel has been activated or
not.
$sel:httpStatus:GetContactChannelResponse'
, getContactChannelResponse_httpStatus
- The response's http status code.
GetContactChannelResponse
, getContactChannelResponse_contactArn
- The ARN of the contact that the channel belongs to.
GetContactChannelResponse
, getContactChannelResponse_contactChannelArn
- The ARN of the contact channel.
GetContactChannelResponse
, getContactChannelResponse_name
- The name of the contact channel
GetContactChannelResponse
, getContactChannelResponse_type
- The type of contact channel. The type is SMS
, VOICE
, or EMAIL
.
GetContactChannelResponse
, getContactChannelResponse_deliveryAddress
- The details that Incident Manager uses when trying to engage the contact
channel.
GetContactPolicy
data GetContactPolicy Source #
See: newGetContactPolicy
smart constructor.
Instances
Create a value of GetContactPolicy
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:
GetContactPolicy
, getContactPolicy_contactArn
- The Amazon Resource Name (ARN) of the contact or escalation plan.
data GetContactPolicyResponse Source #
See: newGetContactPolicyResponse
smart constructor.
Instances
newGetContactPolicyResponse Source #
Create a value of GetContactPolicyResponse
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:
GetContactPolicy
, getContactPolicyResponse_contactArn
- The ARN of the contact or escalation plan.
$sel:policy:GetContactPolicyResponse'
, getContactPolicyResponse_policy
- Details about the resource policy attached to the contact or escalation
plan.
$sel:httpStatus:GetContactPolicyResponse'
, getContactPolicyResponse_httpStatus
- The response's http status code.
ListContactChannels (Paginated)
data ListContactChannels Source #
See: newListContactChannels
smart constructor.
Instances
newListContactChannels Source #
Create a value of ListContactChannels
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListContactChannels'
, listContactChannels_maxResults
- The maximum number of contact channels per page.
ListContactChannels
, listContactChannels_nextToken
- The pagination token to continue to the next page of results.
ListContactChannels
, listContactChannels_contactId
- The Amazon Resource Name (ARN) of the contact.
data ListContactChannelsResponse Source #
See: newListContactChannelsResponse
smart constructor.
Instances
newListContactChannelsResponse Source #
Create a value of ListContactChannelsResponse
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:
ListContactChannels
, listContactChannelsResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListContactChannelsResponse'
, listContactChannelsResponse_httpStatus
- The response's http status code.
$sel:contactChannels:ListContactChannelsResponse'
, listContactChannelsResponse_contactChannels
- A list of contact channels related to the specified contact.
ListContacts (Paginated)
data ListContacts Source #
See: newListContacts
smart constructor.
ListContacts' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ContactType) |
Instances
newListContacts :: ListContacts Source #
Create a value of ListContacts
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:aliasPrefix:ListContacts'
, listContacts_aliasPrefix
- Used to list only contacts who's aliases start with the specified
prefix.
$sel:maxResults:ListContacts'
, listContacts_maxResults
- The maximum number of contacts and escalation plans per page of results.
ListContacts
, listContacts_nextToken
- The pagination token to continue to the next page of results.
ListContacts
, listContacts_type
- The type of contact. A contact is type PERSONAL
and an escalation plan
is type ESCALATION
.
data ListContactsResponse Source #
See: newListContactsResponse
smart constructor.
Instances
newListContactsResponse Source #
Create a value of ListContactsResponse
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:contacts:ListContactsResponse'
, listContactsResponse_contacts
- A list of the contacts and escalation plans in your Incident Manager
account.
ListContacts
, listContactsResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListContactsResponse'
, listContactsResponse_httpStatus
- The response's http status code.
ListEngagements (Paginated)
data ListEngagements Source #
See: newListEngagements
smart constructor.
Instances
newListEngagements :: ListEngagements Source #
Create a value of ListEngagements
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:
ListEngagements
, listEngagements_incidentId
- The Amazon Resource Name (ARN) of the incident you're listing
engagements for.
$sel:maxResults:ListEngagements'
, listEngagements_maxResults
- The maximum number of engagements per page of results.
ListEngagements
, listEngagements_nextToken
- The pagination token to continue to the next page of results.
$sel:timeRangeValue:ListEngagements'
, listEngagements_timeRangeValue
- The time range to lists engagements for an incident.
data ListEngagementsResponse Source #
See: newListEngagementsResponse
smart constructor.
Instances
newListEngagementsResponse Source #
Create a value of ListEngagementsResponse
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:
ListEngagements
, listEngagementsResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListEngagementsResponse'
, listEngagementsResponse_httpStatus
- The response's http status code.
$sel:engagements:ListEngagementsResponse'
, listEngagementsResponse_engagements
- A list of each engagement that occurred during the specified time range
of an incident.
ListPageReceipts (Paginated)
data ListPageReceipts Source #
See: newListPageReceipts
smart constructor.
Instances
Create a value of ListPageReceipts
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListPageReceipts'
, listPageReceipts_maxResults
- The maximum number of acknowledgements per page of results.
ListPageReceipts
, listPageReceipts_nextToken
- The pagination token to continue to the next page of results.
$sel:pageId:ListPageReceipts'
, listPageReceipts_pageId
- The Amazon Resource Name (ARN) of the engagement to a specific contact
channel.
data ListPageReceiptsResponse Source #
See: newListPageReceiptsResponse
smart constructor.
Instances
newListPageReceiptsResponse Source #
Create a value of ListPageReceiptsResponse
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:
ListPageReceipts
, listPageReceiptsResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:receipts:ListPageReceiptsResponse'
, listPageReceiptsResponse_receipts
- A list of each acknowledgement.
$sel:httpStatus:ListPageReceiptsResponse'
, listPageReceiptsResponse_httpStatus
- The response's http status code.
ListPagesByContact (Paginated)
data ListPagesByContact Source #
See: newListPagesByContact
smart constructor.
Instances
newListPagesByContact Source #
Create a value of ListPagesByContact
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListPagesByContact'
, listPagesByContact_maxResults
- The maximum number of engagements to contact channels to list per page
of results.
ListPagesByContact
, listPagesByContact_nextToken
- The pagination token to continue to the next page of results.
ListPagesByContact
, listPagesByContact_contactId
- The Amazon Resource Name (ARN) of the contact you are retrieving
engagements for.
data ListPagesByContactResponse Source #
See: newListPagesByContactResponse
smart constructor.
Instances
newListPagesByContactResponse Source #
Create a value of ListPagesByContactResponse
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:
ListPagesByContact
, listPagesByContactResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListPagesByContactResponse'
, listPagesByContactResponse_httpStatus
- The response's http status code.
$sel:pages:ListPagesByContactResponse'
, listPagesByContactResponse_pages
- The list of engagements to a contact's contact channel.
ListPagesByEngagement (Paginated)
data ListPagesByEngagement Source #
See: newListPagesByEngagement
smart constructor.
Instances
newListPagesByEngagement Source #
Create a value of ListPagesByEngagement
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListPagesByEngagement'
, listPagesByEngagement_maxResults
- The maximum number of engagements to contact channels to list per page
of results.
ListPagesByEngagement
, listPagesByEngagement_nextToken
- The pagination token to continue to the next page of results.
$sel:engagementId:ListPagesByEngagement'
, listPagesByEngagement_engagementId
- The Amazon Resource Name (ARN) of the engagement.
data ListPagesByEngagementResponse Source #
See: newListPagesByEngagementResponse
smart constructor.
Instances
newListPagesByEngagementResponse Source #
Create a value of ListPagesByEngagementResponse
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:
ListPagesByEngagement
, listPagesByEngagementResponse_nextToken
- The pagination token to continue to the next page of results.
$sel:httpStatus:ListPagesByEngagementResponse'
, listPagesByEngagementResponse_httpStatus
- The response's http status code.
$sel:pages:ListPagesByEngagementResponse'
, listPagesByEngagementResponse_pages
- The list of engagements to contact channels.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:ListTagsForResource'
, listTagsForResource_resourceARN
- The Amazon Resource Name (ARN) of the contact or escalation plan.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The tags related to the contact or escalation plan.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
PutContactPolicy
data PutContactPolicy Source #
See: newPutContactPolicy
smart constructor.
Instances
Create a value of PutContactPolicy
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:
PutContactPolicy
, putContactPolicy_contactArn
- The Amazon Resource Name (ARN) of the contact or escalation plan.
$sel:policy:PutContactPolicy'
, putContactPolicy_policy
- Details of the resource policy.
data PutContactPolicyResponse Source #
See: newPutContactPolicyResponse
smart constructor.
Instances
newPutContactPolicyResponse Source #
Create a value of PutContactPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutContactPolicyResponse'
, putContactPolicyResponse_httpStatus
- The response's http status code.
SendActivationCode
data SendActivationCode Source #
See: newSendActivationCode
smart constructor.
Instances
newSendActivationCode Source #
Create a value of SendActivationCode
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:
SendActivationCode
, sendActivationCode_contactChannelId
- The Amazon Resource Name (ARN) of the contact channel.
data SendActivationCodeResponse Source #
See: newSendActivationCodeResponse
smart constructor.
Instances
newSendActivationCodeResponse Source #
Create a value of SendActivationCodeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SendActivationCodeResponse'
, sendActivationCodeResponse_httpStatus
- The response's http status code.
StartEngagement
data StartEngagement Source #
See: newStartEngagement
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> StartEngagement |
Create a value of StartEngagement
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:idempotencyToken:StartEngagement'
, startEngagement_idempotencyToken
- A token ensuring that the operation is called only once with the
specified details.
StartEngagement
, startEngagement_incidentId
- The ARN of the incident that the engagement is part of.
$sel:publicContent:StartEngagement'
, startEngagement_publicContent
- The insecure content of the message that was sent to the contact. Use
this field for engagements to SMS
.
$sel:publicSubject:StartEngagement'
, startEngagement_publicSubject
- The insecure subject of the message that was sent to the contact. Use
this field for engagements to SMS
.
StartEngagement
, startEngagement_contactId
- The Amazon Resource Name (ARN) of the contact being engaged.
StartEngagement
, startEngagement_sender
- The user that started the engagement.
$sel:subject:StartEngagement'
, startEngagement_subject
- The secure subject of the message that was sent to the contact. Use this
field for engagements to VOICE
or EMAIL
.
$sel:content:StartEngagement'
, startEngagement_content
- The secure content of the message that was sent to the contact. Use this
field for engagements to VOICE
or EMAIL
.
data StartEngagementResponse Source #
See: newStartEngagementResponse
smart constructor.
Instances
newStartEngagementResponse Source #
:: Int | |
-> Text | |
-> StartEngagementResponse |
Create a value of StartEngagementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartEngagementResponse'
, startEngagementResponse_httpStatus
- The response's http status code.
StartEngagementResponse
, startEngagementResponse_engagementArn
- The ARN of the engagement.
StopEngagement
data StopEngagement Source #
See: newStopEngagement
smart constructor.
Instances
Create a value of StopEngagement
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:reason:StopEngagement'
, stopEngagement_reason
- The reason that you're stopping the engagement.
$sel:engagementId:StopEngagement'
, stopEngagement_engagementId
- The Amazon Resource Name (ARN) of the engagement.
data StopEngagementResponse Source #
See: newStopEngagementResponse
smart constructor.
Instances
newStopEngagementResponse Source #
Create a value of StopEngagementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopEngagementResponse'
, stopEngagementResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:TagResource'
, tagResource_resourceARN
- The Amazon Resource Name (ARN) of the contact or escalation plan.
$sel:tags:TagResource'
, tagResource_tags
- A list of tags that you are adding to the contact or escalation plan.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:UntagResource'
, untagResource_resourceARN
- The Amazon Resource Name (ARN) of the contact or escalation plan.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The key of the tag that you want to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateContact
data UpdateContact Source #
See: newUpdateContact
smart constructor.
Instances
Create a value of UpdateContact
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:
UpdateContact
, updateContact_displayName
- The full name of the contact or escalation plan.
$sel:plan:UpdateContact'
, updateContact_plan
- A list of stages. A contact has an engagement plan with stages for
specified contact channels. An escalation plan uses these stages to
contact specified contacts.
UpdateContact
, updateContact_contactId
- The Amazon Resource Name (ARN) of the contact or escalation plan you're
updating.
data UpdateContactResponse Source #
See: newUpdateContactResponse
smart constructor.
Instances
newUpdateContactResponse Source #
Create a value of UpdateContactResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateContactResponse'
, updateContactResponse_httpStatus
- The response's http status code.
UpdateContactChannel
data UpdateContactChannel Source #
See: newUpdateContactChannel
smart constructor.
Instances
newUpdateContactChannel Source #
Create a value of UpdateContactChannel
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:
UpdateContactChannel
, updateContactChannel_deliveryAddress
- The details that Incident Manager uses when trying to engage the contact
channel.
UpdateContactChannel
, updateContactChannel_name
- The name of the contact channel.
UpdateContactChannel
, updateContactChannel_contactChannelId
- The Amazon Resource Name (ARN) of the contact channel you want to
update.
data UpdateContactChannelResponse Source #
See: newUpdateContactChannelResponse
smart constructor.
Instances
newUpdateContactChannelResponse Source #
Create a value of UpdateContactChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateContactChannelResponse'
, updateContactChannelResponse_httpStatus
- The response's http status code.
Types
AcceptCodeValidation
newtype AcceptCodeValidation Source #
pattern AcceptCodeValidation_ENFORCE :: AcceptCodeValidation | |
pattern AcceptCodeValidation_IGNORE :: AcceptCodeValidation |
Instances
AcceptType
newtype AcceptType Source #
pattern AcceptType_DELIVERED :: AcceptType | |
pattern AcceptType_READ :: AcceptType |
Instances
ActivationStatus
newtype ActivationStatus Source #
pattern ActivationStatus_ACTIVATED :: ActivationStatus | |
pattern ActivationStatus_NOT_ACTIVATED :: ActivationStatus |
Instances
ChannelType
newtype ChannelType Source #
pattern ChannelType_EMAIL :: ChannelType | |
pattern ChannelType_SMS :: ChannelType | |
pattern ChannelType_VOICE :: ChannelType |
Instances
ContactType
newtype ContactType Source #
pattern ContactType_ESCALATION :: ContactType | |
pattern ContactType_PERSONAL :: ContactType |
Instances
ReceiptType
newtype ReceiptType Source #
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.
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.
Contact
A personal contact or escalation plan that Incident Manager engages during an incident.
See: newContact
smart constructor.
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)))) |
:: 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
.
ContactChannel
data ContactChannel Source #
The method that Incident Manager uses to engage a contact.
See: newContactChannel
smart constructor.
Instances
:: 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.
ContactChannelAddress
data ContactChannelAddress Source #
The details that Incident Manager uses when trying to engage the contact channel.
See: newContactChannelAddress
smart constructor.
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
ContactTargetInfo
data ContactTargetInfo Source #
The contact that Incident Manager is engaging during an incident.
See: newContactTargetInfo
smart constructor.
Instances
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.
Engagement
data Engagement Source #
Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.
See: newEngagement
smart constructor.
Instances
:: 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.
Page
Incident Manager engaging a contact's contact channel.
See: newPage
smart constructor.
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.
Plan
The stages that an escalation plan or engagement plan engages contacts and contact methods in.
See: newPlan
smart constructor.
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.
Receipt
Records events during an engagement.
See: newReceipt
smart constructor.
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
.
Stage
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
See: newStage
smart constructor.
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.
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.
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.
TimeRange
A range of between two set times
See: newTimeRange
smart constructor.
TimeRange' (Maybe POSIX) (Maybe POSIX) |
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.