Skip to content

Commit 2843c76

Browse files
author
AWS
committed
Amazon Connect Service Update: Add support for Push Notifications for Amazon Connect chat. With Push Notifications enabled an alert could be sent to customers about new messages even when they aren't actively using the mobile application.
1 parent 92a5565 commit 2843c76

File tree

2 files changed

+161
-0
lines changed

2 files changed

+161
-0
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Connect Service",
4+
"contributor": "",
5+
"description": "Add support for Push Notifications for Amazon Connect chat. With Push Notifications enabled an alert could be sent to customers about new messages even when they aren't actively using the mobile application."
6+
}

services/connect/src/main/resources/codegen-resources/service-2.json

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -666,6 +666,24 @@
666666
],
667667
"documentation":"<p>Creates a prompt. For more information about prompts, such as supported file types and maximum length, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html\">Create prompts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
668668
},
669+
"CreatePushNotificationRegistration":{
670+
"name":"CreatePushNotificationRegistration",
671+
"http":{
672+
"method":"PUT",
673+
"requestUri":"/push-notification/{InstanceId}/registrations"
674+
},
675+
"input":{"shape":"CreatePushNotificationRegistrationRequest"},
676+
"output":{"shape":"CreatePushNotificationRegistrationResponse"},
677+
"errors":[
678+
{"shape":"InvalidParameterException"},
679+
{"shape":"ResourceNotFoundException"},
680+
{"shape":"ThrottlingException"},
681+
{"shape":"InternalServiceException"},
682+
{"shape":"AccessDeniedException"},
683+
{"shape":"ServiceQuotaExceededException"}
684+
],
685+
"documentation":"<p>Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-up-push-notifications-for-mobile-chat.html\">Set up push notifications in Amazon Connect for mobile chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
686+
},
669687
"CreateQueue":{
670688
"name":"CreateQueue",
671689
"http":{
@@ -1118,6 +1136,23 @@
11181136
],
11191137
"documentation":"<p>Deletes a prompt.</p>"
11201138
},
1139+
"DeletePushNotificationRegistration":{
1140+
"name":"DeletePushNotificationRegistration",
1141+
"http":{
1142+
"method":"DELETE",
1143+
"requestUri":"/push-notification/{InstanceId}/registrations/{RegistrationId}"
1144+
},
1145+
"input":{"shape":"DeletePushNotificationRegistrationRequest"},
1146+
"output":{"shape":"DeletePushNotificationRegistrationResponse"},
1147+
"errors":[
1148+
{"shape":"InvalidParameterException"},
1149+
{"shape":"ResourceNotFoundException"},
1150+
{"shape":"ThrottlingException"},
1151+
{"shape":"InternalServiceException"},
1152+
{"shape":"AccessDeniedException"}
1153+
],
1154+
"documentation":"<p>Deletes registration for a device token and a chat contact.</p>"
1155+
},
11211156
"DeleteQueue":{
11221157
"name":"DeleteQueue",
11231158
"http":{
@@ -6786,6 +6821,25 @@
67866821
},
67876822
"documentation":"<p>A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.</p>"
67886823
},
6824+
"ContactConfiguration":{
6825+
"type":"structure",
6826+
"required":["ContactId"],
6827+
"members":{
6828+
"ContactId":{
6829+
"shape":"ContactId",
6830+
"documentation":"<p>The identifier of the contact within the Amazon Connect instance.</p>"
6831+
},
6832+
"ParticipantRole":{
6833+
"shape":"ParticipantRole",
6834+
"documentation":"<p>The role of the participant in the chat conversation.</p>"
6835+
},
6836+
"IncludeRawMessage":{
6837+
"shape":"IncludeRawMessage",
6838+
"documentation":"<p>Whether to include raw connect message in the push notification payload. Default is <code>False</code>.</p>"
6839+
}
6840+
},
6841+
"documentation":"<p>The contact configuration for push notification registration.</p>"
6842+
},
67896843
"ContactDataRequest":{
67906844
"type":"structure",
67916845
"members":{
@@ -8134,6 +8188,55 @@
81348188
}
81358189
}
81368190
},
8191+
"CreatePushNotificationRegistrationRequest":{
8192+
"type":"structure",
8193+
"required":[
8194+
"InstanceId",
8195+
"PinpointAppArn",
8196+
"DeviceToken",
8197+
"DeviceType",
8198+
"ContactConfiguration"
8199+
],
8200+
"members":{
8201+
"InstanceId":{
8202+
"shape":"InstanceId",
8203+
"documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>",
8204+
"location":"uri",
8205+
"locationName":"InstanceId"
8206+
},
8207+
"ClientToken":{
8208+
"shape":"ClientToken",
8209+
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>",
8210+
"idempotencyToken":true
8211+
},
8212+
"PinpointAppArn":{
8213+
"shape":"ARN",
8214+
"documentation":"<p>The Amazon Resource Name (ARN) of the Pinpoint application.</p>"
8215+
},
8216+
"DeviceToken":{
8217+
"shape":"DeviceToken",
8218+
"documentation":"<p>The push notification token issued by the Apple or Google gateways.</p>"
8219+
},
8220+
"DeviceType":{
8221+
"shape":"DeviceType",
8222+
"documentation":"<p>The device type to use when sending the message.</p>"
8223+
},
8224+
"ContactConfiguration":{
8225+
"shape":"ContactConfiguration",
8226+
"documentation":"<p>The contact configuration for push notification registration.</p>"
8227+
}
8228+
}
8229+
},
8230+
"CreatePushNotificationRegistrationResponse":{
8231+
"type":"structure",
8232+
"required":["RegistrationId"],
8233+
"members":{
8234+
"RegistrationId":{
8235+
"shape":"RegistrationId",
8236+
"documentation":"<p>The identifier for the registration.</p>"
8237+
}
8238+
}
8239+
},
81378240
"CreateQueueRequest":{
81388241
"type":"structure",
81398242
"required":[
@@ -9384,6 +9487,39 @@
93849487
}
93859488
}
93869489
},
9490+
"DeletePushNotificationRegistrationRequest":{
9491+
"type":"structure",
9492+
"required":[
9493+
"InstanceId",
9494+
"RegistrationId",
9495+
"ContactId"
9496+
],
9497+
"members":{
9498+
"InstanceId":{
9499+
"shape":"InstanceId",
9500+
"documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>",
9501+
"location":"uri",
9502+
"locationName":"InstanceId"
9503+
},
9504+
"RegistrationId":{
9505+
"shape":"RegistrationId",
9506+
"documentation":"<p>The identifier for the registration.</p>",
9507+
"location":"uri",
9508+
"locationName":"RegistrationId"
9509+
},
9510+
"ContactId":{
9511+
"shape":"ContactId",
9512+
"documentation":"<p>The identifier of the contact within the Amazon Connect instance.</p>",
9513+
"location":"querystring",
9514+
"locationName":"contactId"
9515+
}
9516+
}
9517+
},
9518+
"DeletePushNotificationRegistrationResponse":{
9519+
"type":"structure",
9520+
"members":{
9521+
}
9522+
},
93879523
"DeleteQueueRequest":{
93889524
"type":"structure",
93899525
"required":[
@@ -10552,6 +10688,19 @@
1055210688
},
1055310689
"documentation":"<p>Information regarding the device.</p>"
1055410690
},
10691+
"DeviceToken":{
10692+
"type":"string",
10693+
"max":500,
10694+
"min":1
10695+
},
10696+
"DeviceType":{
10697+
"type":"string",
10698+
"enum":[
10699+
"GCM",
10700+
"APNS",
10701+
"APNS_SANDBOX"
10702+
]
10703+
},
1055510704
"Dimensions":{
1055610705
"type":"structure",
1055710706
"members":{
@@ -13783,6 +13932,7 @@
1378313932
"min":0,
1378413933
"sensitive":true
1378513934
},
13935+
"IncludeRawMessage":{"type":"boolean"},
1378613936
"Index":{"type":"integer"},
1378713937
"InitiateAs":{
1378813938
"type":"string",
@@ -18997,6 +19147,11 @@
1899719147
"type":"string",
1899819148
"pattern":"[a-z]{2}(-[a-z]+){1,2}(-[0-9])?"
1899919149
},
19150+
"RegistrationId":{
19151+
"type":"string",
19152+
"max":256,
19153+
"min":1
19154+
},
1900019155
"RehydrationType":{
1900119156
"type":"string",
1900219157
"enum":[

0 commit comments

Comments
 (0)