amazon connect serviceamazon connect service api reference welcome amazon connect is a cloud-based...

Amazon Connect ServiceAPI Reference

API Version 2017-08-08

Amazon Connect Service API Reference

Amazon Connect Service: API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

CreateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

DeleteUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

DescribeUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

DescribeUserHierarchyGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

DescribeUserHierarchyStructure .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

GetContactAttributes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

GetCurrentMetricData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

API Version 2017-08-08iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

GetFederationToken .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

GetMetricData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

ListContactFlows .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

ListHoursOfOperations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

ListPhoneNumbers .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

ListQueues .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

ListRoutingProfiles .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

API Version 2017-08-08iv


Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

ListSecurityProfiles .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

ListUserHierarchyGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

ListUsers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

StartChatContact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

StartOutboundVoiceContact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

StopContact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

API Version 2017-08-08v


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

UpdateContactAttributes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

UpdateUserHierarchy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

UpdateUserIdentityInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

UpdateUserPhoneConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

UpdateUserRoutingProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

API Version 2017-08-08vi


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

UpdateUserSecurityProfiles .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92ChatMessage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

ContactFlowSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Credentials ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

CurrentMetric ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

CurrentMetricData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

CurrentMetricResult ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Dimensions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Filters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

HierarchyGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

HierarchyGroupSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

HierarchyLevel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

HierarchyPath .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

HierarchyStructure .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

HistoricalMetric ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

HistoricalMetricData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

API Version 2017-08-08vii


HistoricalMetricResult ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

HoursOfOperationSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

ParticipantDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

PhoneNumberSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

QueueReference .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

QueueSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

RoutingProfileSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

SecurityProfileSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Threshold .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

User .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

UserIdentityInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

UserPhoneConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

UserSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

API Version 2017-08-08viii


WelcomeAmazon Connect is a cloud-based contact center solution that makes it easy to set up and manage acustomer contact center and provide reliable customer engagement at any scale.

Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contactrouting. You can also resolve customer issues more efficiently by putting customers in touch with theright agents.

There are limits to the number of Amazon Connect resources that you can create and limits to thenumber of requests that you can make per second. For more information, see Amazon Connect ServiceQuotas in the Amazon Connect Administrator Guide.

To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connectendpoints, see Amazon Connect Endpoints.

This document was last published on June 16, 2020.


https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html


https://docs.aws.amazon.com/general/latest/gr/connect_region.html


ActionsThe following actions are supported:

• CreateUser (p. 3)• DeleteUser (p. 7)• DescribeUser (p. 9)• DescribeUserHierarchyGroup (p. 12)• DescribeUserHierarchyStructure (p. 15)• GetContactAttributes (p. 18)• GetCurrentMetricData (p. 20)• GetFederationToken (p. 27)• GetMetricData (p. 29)• ListContactFlows (p. 38)• ListHoursOfOperations (p. 41)• ListPhoneNumbers (p. 44)• ListQueues (p. 47)• ListRoutingProfiles (p. 50)• ListSecurityProfiles (p. 53)• ListTagsForResource (p. 56)• ListUserHierarchyGroups (p. 58)• ListUsers (p. 61)• StartChatContact (p. 64)• StartOutboundVoiceContact (p. 68)• StopContact (p. 72)• TagResource (p. 74)• UntagResource (p. 76)• UpdateContactAttributes (p. 78)• UpdateUserHierarchy (p. 81)• UpdateUserIdentityInfo (p. 83)• UpdateUserPhoneConfig (p. 86)• UpdateUserRoutingProfile (p. 88)• UpdateUserSecurityProfiles (p. 90)


Amazon Connect Service API ReferenceCreateUser

CreateUserCreates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users inthe Amazon Connect Administrator Guide.

Request SyntaxPUT /users/InstanceId HTTP/1.1Content-type: application/json

{ "DirectoryUserId": "string", "HierarchyGroupId": "string", "IdentityInfo": { "Email": "string", "FirstName": "string", "LastName": "string" }, "Password": "string", "PhoneConfig": { "AfterContactWorkTimeLimit": number, "AutoAccept": boolean, "DeskPhoneNumber": "string", "PhoneType": "string" }, "RoutingProfileId": "string", "SecurityProfileIds": [ "string" ], "Tags": { "string" : "string" }, "Username": "string"}

URI Request ParametersThe request uses the following URI parameters.

InstanceId (p. 3)

The identifier of the Amazon Connect instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request BodyThe request accepts the following data in JSON format.

DirectoryUserId (p. 3)

The identifier of the user account in the directory used for identity management. If Amazon Connectcannot access the directory, you can specify this identifier to authenticate users. If you include theidentifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identityinformation is used to authenticate users from your directory.


https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html

Amazon Connect Service API ReferenceRequest Body

This parameter is required if you are using an existing directory for identity management in AmazonConnect when Amazon Connect cannot access your directory to authenticate users. If you are usingSAML for identity management and include this parameter, an error is returned.

Type: String

Required: NoHierarchyGroupId (p. 3)

The identifier of the hierarchy group for the user.

Type: String

Required: NoIdentityInfo (p. 3)

The information about the identity of the user.

Type: UserIdentityInfo (p. 121) object

Required: NoPassword (p. 3)

The password for the user account. A password is required if you are using Amazon Connect foridentity management. Otherwise, it is an error to include a password.

Type: String

Pattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,64}$/

Required: NoPhoneConfig (p. 3)

The phone settings for the user.

Type: UserPhoneConfig (p. 122) object

Required: YesRoutingProfileId (p. 3)

The identifier of the routing profile for the user.

Type: String

Required: YesSecurityProfileIds (p. 3)

The identifier of the security profile for the user.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: YesTags (p. 3)

One or more tags.

Type: String to string map


Amazon Connect Service API ReferenceResponse Syntax

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: NoUsername (p. 3)

The user name for the account. For instances not using SAML for identity management, the username can include up to 20 characters. If you are using SAML for identity management, the username can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Type: String


Required: Yes

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "UserArn": "string", "UserId": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

UserArn (p. 5)

The Amazon Resource Name (ARN) of the user account.

Type: StringUserId (p. 5)

The identifier of the user account.

Type: String

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 126).

DuplicateResourceException

A resource with the specified name already exists.


Amazon Connect Service API ReferenceSee Also

HTTP Status Code: 409InternalServiceException

Request processing failed due to an error or failure with the service.

HTTP Status Code: 500InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400InvalidRequestException

The request is not valid.

HTTP Status Code: 400LimitExceededException

The allowed limit for the resource has been exceeded.

HTTP Status Code: 429ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/CreateUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/CreateUser

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateUser

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/CreateUser

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/CreateUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/CreateUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateUser

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateUser

Amazon Connect Service API ReferenceDeleteUser

DeleteUserDeletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Usersfrom Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

Request SyntaxDELETE /users/InstanceId/UserId HTTP/1.1


InstanceId (p. 7)



Required: YesUserId (p. 7)

The identifier of the user.

Required: Yes

Request BodyThe request does not have a request body.

Response SyntaxHTTP/1.1 200

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


InternalServiceException





https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html

https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html












https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/DeleteUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/DeleteUser

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteUser

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/DeleteUser

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/DeleteUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/DeleteUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteUser

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteUser

Amazon Connect Service API ReferenceDescribeUser

DescribeUserDescribes the specified user account. You can find the instance ID in the console (it’s the final part of theARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in theoutput.

Request SyntaxGET /users/InstanceId/UserId HTTP/1.1


InstanceId (p. 9)





Required: Yes



{ "User": { "Arn": "string", "DirectoryUserId": "string", "HierarchyGroupId": "string", "Id": "string", "IdentityInfo": { "Email": "string", "FirstName": "string", "LastName": "string" }, "PhoneConfig": { "AfterContactWorkTimeLimit": number, "AutoAccept": boolean, "DeskPhoneNumber": "string", "PhoneType": "string" }, "RoutingProfileId": "string", "SecurityProfileIds": [ "string" ],


Amazon Connect Service API ReferenceResponse Elements

"Tags": { "string" : "string" }, "Username": "string" }}



User (p. 9)

Information about the user account and configuration settings.

Type: User (p. 119) object














• AWS Command Line Interface• AWS SDK for .NET


https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/DescribeUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/DescribeUser


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeUser

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/DescribeUser

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/DescribeUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/DescribeUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeUser

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeUser

Amazon Connect Service API ReferenceDescribeUserHierarchyGroup

DescribeUserHierarchyGroupDescribes the specified hierarchy group.

Request SyntaxGET /user-hierarchy-groups/InstanceId/HierarchyGroupId HTTP/1.1


HierarchyGroupId (p. 12)

The identifier of the hierarchy group.

Required: Yes

InstanceId (p. 12)



Required: Yes



{ "HierarchyGroup": { "Arn": "string", "HierarchyPath": { "LevelFive": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelFour": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelOne": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelThree": {



"Arn": "string", "Id": "string", "Name": "string" }, "LevelTwo": { "Arn": "string", "Id": "string", "Name": "string" } }, "Id": "string", "LevelId": "string", "Name": "string" }}



HierarchyGroup (p. 12)

Information about the hierarchy group.

Type: HierarchyGroup (p. 101) object





InvalidParameterException



InvalidRequestException



ResourceNotFoundException



ThrottlingException








https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/DescribeUserHierarchyGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/DescribeUserHierarchyGroup

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeUserHierarchyGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/DescribeUserHierarchyGroup

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/DescribeUserHierarchyGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/DescribeUserHierarchyGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeUserHierarchyGroup

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeUserHierarchyGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeUserHierarchyGroup

Amazon Connect Service API ReferenceDescribeUserHierarchyStructure

DescribeUserHierarchyStructureDescribes the hierarchy structure of the specified Amazon Connect instance.

Request SyntaxGET /user-hierarchy-structure/InstanceId HTTP/1.1


InstanceId (p. 15)



Required: Yes



{ "HierarchyStructure": { "LevelFive": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelFour": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelOne": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelThree": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelTwo": { "Arn": "string", "Id": "string", "Name": "string" }



}}



HierarchyStructure (p. 15)

Information about the hierarchy structure.

Type: HierarchyStructure (p. 105) object














• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java


https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/DescribeUserHierarchyStructure

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/DescribeUserHierarchyStructure

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeUserHierarchyStructure

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/DescribeUserHierarchyStructure

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/DescribeUserHierarchyStructure


• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/DescribeUserHierarchyStructure

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeUserHierarchyStructure

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeUserHierarchyStructure

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeUserHierarchyStructure

Amazon Connect Service API ReferenceGetContactAttributes

GetContactAttributesRetrieves the contact attributes for the specified contact.

Request SyntaxGET /contact/attributes/InstanceId/InitialContactId HTTP/1.1


InitialContactId (p. 18)

The identifier of the initial contact.


Required: YesInstanceId (p. 18)



Required: Yes



{ "Attributes": { "string" : "string" }}



Attributes (p. 18)

Information about the attributes.



Amazon Connect Service API ReferenceErrors


Value Length Constraints: Minimum length of 0. Maximum length of 32767.












https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/GetContactAttributes

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/GetContactAttributes

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetContactAttributes

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/GetContactAttributes

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/GetContactAttributes

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/GetContactAttributes

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetContactAttributes

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetContactAttributes

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetContactAttributes

Amazon Connect Service API ReferenceGetCurrentMetricData

GetCurrentMetricDataGets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect AdministratorGuide.

Request SyntaxPOST /metrics/current/InstanceId HTTP/1.1Content-type: application/json

{ "CurrentMetrics": [ { "Name": "string", "Unit": "string" } ], "Filters": { "Channels": [ "string" ], "Queues": [ "string" ] }, "Groupings": [ "string" ], "MaxResults": number, "NextToken": "string"}


InstanceId (p. 20)



Required: Yes


CurrentMetrics (p. 20)

The metrics to retrieve. Specify the name and unit for each metric. The following metrics areavailable. For a description of all the metrics, see Real-time Metrics Definitions in the AmazonConnect Administrator Guide.AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

Name in real-time metrics report: ACWAGENTS_AVAILABLE

Unit: COUNT


https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html


https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time


Name in real-time metrics report: AvailableAGENTS_ERROR

Unit: COUNT

Name in real-time metrics report: ErrorAGENTS_NON_PRODUCTIVE

Unit: COUNT

Name in real-time metrics report: NPT (Non-Productive Time)AGENTS_ON_CALL

Unit: COUNT

Name in real-time metrics report: On contactAGENTS_ON_CONTACT

Unit: COUNT

Name in real-time metrics report: On contactAGENTS_ONLINE

Unit: COUNT

Name in real-time metrics report: OnlineAGENTS_STAFFED

Unit: COUNT

Name in real-time metrics report: StaffedCONTACTS_IN_QUEUE

Unit: COUNT

Name in real-time metrics report: In queueCONTACTS_SCHEDULED

Unit: COUNT

Name in real-time metrics report: ScheduledOLDEST_CONTACT_AGE

Unit: SECONDS

When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. Forexample, if you get a response like this:

{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" },"Value": 24113.0 }

The actual OLDEST_CONTACT_AGE is 24 seconds.

Name in real-time metrics report: OldestSLOTS_ACTIVE

Unit: COUNT

Name in real-time metrics report: Active


https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time

https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time


SLOTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Availability

Type: Array of CurrentMetric (p. 96) objects

Required: YesFilters (p. 20)

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved onlyfor the resources associated with the queues or channels included in the filter. You can include bothqueue IDs and queue ARNs in the same request. The only supported channel is VOICE.

Type: Filters (p. 100) object

Required: YesGroupings (p. 20)

The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metricsreturned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, youshould include a Channels filter. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of metrics is returned.


Array Members: Maximum number of 2 items.

Valid Values: QUEUE | CHANNEL

Required: NoMaxResults (p. 20)

The maximimum number of results to return per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: NoNextToken (p. 20)

The token for the next set of results. Use the value returned in the previous response in the nextrequest to retrieve the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use thetoken must use the same request parameters as the request that generated the token.

Type: String

Required: No



https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time


{ "DataSnapshotTime": number, "MetricResults": [ { "Collections": [ { "Metric": { "Name": "string", "Unit": "string" }, "Value": number } ], "Dimensions": { "Channel": "string", "Queue": { "Arn": "string", "Id": "string" } } } ], "NextToken": "string"}



DataSnapshotTime (p. 22)

The time at which the metrics were retrieved and cached for pagination.

Type: TimestampMetricResults (p. 22)

Information about the real-time metrics.

Type: Array of CurrentMetricResult (p. 98) objectsNextToken (p. 22)

If there are additional results, this is the token for the next set of results.


Type: String






Amazon Connect Service API ReferenceExample










Example

The following example retrieves the specified real-time metrics.

Sample Request

{ "InstanceId" : "12345678-1234-5678-aabb-123456abcdef", "Filters" : { "Queues" : [ "11111111-2222-fcfc-abab-333333333333", "arn:aws:connect:us-east-1:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/11111111-2222-fcfc-abab-333333333333" ], "Channels" : ["VOICE"] }, "Groupings" : [ "CHANNEL", "QUEUE" ], "CurrentMetrics" : [ { "Name" : "AGENTS_ONLINE", "Unit" : "COUNT" }, { "Name" : "AGENTS_AVAILABLE", "Unit" : "COUNT" }, { "Name" : "OLDEST_CONTACT_AGE", "Unit" : "SECONDS" }, { "Name": "AGENTS_ERROR", "Unit": "COUNT" } ]



}

Sample Response

{ "DataSnapshotTime": 1549059604.884, "MetricResults": [ { "Collections": [ { "Metric": { "Name": "AGENTS_ONLINE", "Unit": "COUNT" }, "Value": 1 }, { "Metric": { "Name": "AGENTS_AVAILABLE", "Unit": "COUNT" }, "Value": 1 }, { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 0 }, { "Metric": { "Name": "AGENTS_ERROR", "Unit": "COUNT" }, "Value": 0 } ], "Dimensions": { "Channel": "VOICE" "Queue": { "Arn": "arn:aws:connect:us-east-1:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/11111111-2222-fcfc-abab-333333333333", "Id": "11111111-2222-fcfc-abab-333333333333" }, } } ]}


• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript


https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/GetCurrentMetricData

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/GetCurrentMetricData

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetCurrentMetricData

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/GetCurrentMetricData

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/GetCurrentMetricData

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/GetCurrentMetricData


• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetCurrentMetricData

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetCurrentMetricData

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetCurrentMetricData

Amazon Connect Service API ReferenceGetFederationToken

GetFederationTokenRetrieves a token for federation.

Request SyntaxGET /user/federate/InstanceId HTTP/1.1


InstanceId (p. 27)



Required: Yes



{ "Credentials": { "AccessToken": "string", "AccessTokenExpiration": number, "RefreshToken": "string", "RefreshTokenExpiration": number }}



Credentials (p. 27)

The credentials to use for federation.

Type: Credentials (p. 95) object




DuplicateResourceException

A resource with the specified name already exists.









HTTP Status Code: 404UserNotFoundException

No user with the specified credentials was found in the Amazon Connect instance.





https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/GetFederationToken

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/GetFederationToken

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetFederationToken

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/GetFederationToken

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/GetFederationToken

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/GetFederationToken

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetFederationToken

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetFederationToken

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetFederationToken

Amazon Connect Service API ReferenceGetMetricData

GetMetricDataGets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon ConnectAdministrator Guide.

Request SyntaxPOST /metrics/historical/InstanceId HTTP/1.1Content-type: application/json

{ "EndTime": number, "Filters": { "Channels": [ "string" ], "Queues": [ "string" ] }, "Groupings": [ "string" ], "HistoricalMetrics": [ { "Name": "string", "Statistic": "string", "Threshold": { "Comparison": "string", "ThresholdValue": number }, "Unit": "string" } ], "MaxResults": number, "NextToken": "string", "StartTime": number}


InstanceId (p. 29)



Required: Yes


EndTime (p. 29)

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrievalof historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00,11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.


https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html


Type: Timestamp

Required: YesFilters (p. 29)

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved onlyfor the resources associated with the queues or channels included in the filter. You can include bothqueue IDs and queue ARNs in the same request. The only supported channel is VOICE.

Type: Filters (p. 100) object

Required: YesGroupings (p. 29)

The grouping applied to the metrics returned. For example, when results are grouped by queue, themetrics returned are grouped by queue. The values returned apply to the metrics for each queuerather than aggregated for all queues.

The only supported grouping is QUEUE.

If no grouping is specified, a summary of metrics for all queues is returned.



Valid Values: QUEUE | CHANNEL

Required: NoHistoricalMetrics (p. 29)

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historicalmetrics are available. For a description of each metric, see Historical Metrics Definitions in theAmazon Connect Administrator Guide.ABANDON_TIME

Unit: SECONDS

Statistic: AVGAFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVGAPI_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUMCALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUMCONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM




CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUMCONTACTS_CONSULTED

Unit: COUNT

Statistic: SUMCONTACTS_HANDLED

Unit: COUNT

Statistic: SUMCONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUMCONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUMCONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUMCONTACTS_MISSED

Unit: COUNT

Statistic: SUMCONTACTS_QUEUED

Unit: COUNT

Statistic: SUMCONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUMCONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUMCONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUMCONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM



HANDLE_TIME

Unit: SECONDS

Statistic: AVGHOLD_TIME

Unit: SECONDS

Statistic: AVGINTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVGINTERACTION_TIME

Unit: SECONDS

Statistic: AVGOCCUPANCY

Unit: PERCENT

Statistic: AVGQUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVGQUEUED_TIME

Unit: SECONDS

Statistic: MAXSERVICE_LEVEL

Unit: PERCENT

Statistic: AVG

Threshold: Only "Less than" comparisons are supported, with the following service levelthresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

Type: Array of HistoricalMetric (p. 106) objects

Required: YesMaxResults (p. 29)


Type: Integer


Required: NoNextToken (p. 29)




Type: String

Required: NoStartTime (p. 29)

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrievalof historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05,10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics areavailable only for 24 hours.

Type: Timestamp

Required: Yes


{ "MetricResults": [ { "Collections": [ { "Metric": { "Name": "string", "Statistic": "string", "Threshold": { "Comparison": "string", "ThresholdValue": number }, "Unit": "string" }, "Value": number } ], "Dimensions": { "Channel": "string", "Queue": { "Arn": "string", "Id": "string" } } } ], "NextToken": "string"}



MetricResults (p. 33)

Information about the historical metrics.



If no grouping is specified, a summary of metric data is returned.

Type: Array of HistoricalMetricResult (p. 109) objectsNextToken (p. 33)



Type: String













Example

The following example retrieves the specified historical metrics.

Sample Request

{ "InstanceId" : "12345678-1234-5678-aabb-123456abcdef", "StartTime": 1548979200, "EndTime": 1549051200, "Filters" : { "Queues" : [ "11111111-2222-fcfc-abab-333333333333" ],


Amazon Connect Service API ReferenceExample

"Channels" : ["VOICE"] }, "Groupings" : [ "QUEUE", "CHANNEL" ], "HistoricalMetrics" : [ { "Name" : "AFTER_CONTACT_WORK_TIME", "Unit" : "SECONDS", "Statistic" : "AVG" }, { "Name" : "CONTACTS_QUEUED", "Unit" : "COUNT", "Statistic" : "SUM" }, { "Name" : "CONTACTS_HANDLED", "Unit" : "COUNT", "Statistic" : "SUM" }, { "Name" : "HANDLE_TIME", "Unit" : "SECONDS", "Statistic" : "AVG" }, { "Name" : "CONTACTS_TRANSFERRED_OUT", "Unit" : "COUNT", "Statistic" : "SUM" }, { "Name" : "CONTACTS_MISSED", "Unit" : "COUNT", "Statistic" : "SUM" }, { "Name" : "OCCUPANCY", "Unit" : "PERCENT", "Statistic" : "AVG" }, { "Name" : "QUEUED_TIME", "Unit" : "SECONDS", "Statistic" : "MAX" }, { "Name" : "HOLD_TIME", "Unit" : "SECONDS", "Statistic" : "AVG" }, { "Name" : "SERVICE_LEVEL", "Threshold" : { "Comparison" : "LT", "ThresholdValue" : 60.0 }, "Unit" : "PERCENT", "Statistic" : "AVG" }, { "Name" : "SERVICE_LEVEL", "Threshold" : { "Comparison" : "LT", "ThresholdValue" : 120.0



}, "Unit" : "PERCENT", "Statistic" : "AVG" }, { "Name" : "SERVICE_LEVEL", "Threshold" : { "Comparison" : "LT", "ThresholdValue" : 30.0 }, "Unit" : "PERCENT", "Statistic" : "AVG" } ]}

Sample Response

{ "MetricResults": [ { "Collections": [ { "Metric": { "Name": "OCCUPANCY", "Statistic": "AVG", "Threshold": null, "Unit": "PERCENT" }, "Value": 0 }, { "Metric": { "Name": "CONTACTS_MISSED", "Statistic": "SUM", "Threshold": null, "Unit": "COUNT" }, "Value": 0 } ], "Dimensions": { "Channel": "VOICE", "Queue": { "Arn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/11111111-2222-fcfc-abab-333333333333", "Id": "11111111-2222-fcfc-abab-333333333333" } } } ]}


• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go


https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/GetMetricData

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/GetMetricData

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetMetricData

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/GetMetricData


• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/GetMetricData

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/GetMetricData

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetMetricData

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetMetricData

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetMetricData

Amazon Connect Service API ReferenceListContactFlows

ListContactFlowsProvides information about the contact flows for the specified Amazon Connect instance.

For more information about contact flows, see Contact Flows in the Amazon Connect AdministratorGuide.

Request SyntaxGET /contact-flows-summary/InstanceId?contactFlowTypes=ContactFlowTypes&maxResults=MaxResults&nextToken=NextToken HTTP/1.1


ContactFlowTypes (p. 38)

The type of contact flow.


Valid Values: CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER| AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER |QUEUE_TRANSFER

InstanceId (p. 38)



Required: Yes

MaxResults (p. 38)



NextToken (p. 38)




{


https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html


"ContactFlowSummaryList": [ { "Arn": "string", "ContactFlowType": "string", "Id": "string", "Name": "string" } ], "NextToken": "string"}



ContactFlowSummaryList (p. 38)

Information about the contact flows.

Type: Array of ContactFlowSummary (p. 94) objectsNextToken (p. 38)


Type: String


















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/ListContactFlows

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/ListContactFlows

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListContactFlows

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ListContactFlows

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ListContactFlows

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/ListContactFlows

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListContactFlows

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListContactFlows

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListContactFlows

Amazon Connect Service API ReferenceListHoursOfOperations

ListHoursOfOperationsProvides information about the hours of operation for the specified Amazon Connect instance.

For more information about hours of operation, see Set the Hours of Operation for a Queue in theAmazon Connect Administrator Guide.

Request SyntaxGET /hours-of-operations-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1


InstanceId (p. 41)



Required: Yes

MaxResults (p. 41)



NextToken (p. 41)




{ "HoursOfOperationSummaryList": [ { "Arn": "string", "Id": "string", "Name": "string" } ], "NextToken": "string"}


https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html




HoursOfOperationSummaryList (p. 41)

Information about the hours of operation.

Type: Array of HoursOfOperationSummary (p. 110) objectsNextToken (p. 41)


Type: String
















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/ListHoursOfOperations

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/ListHoursOfOperations

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListHoursOfOperations

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ListHoursOfOperations




https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ListHoursOfOperations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/ListHoursOfOperations

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListHoursOfOperations

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListHoursOfOperations

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListHoursOfOperations

Amazon Connect Service API ReferenceListPhoneNumbers

ListPhoneNumbersProvides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in theAmazon Connect Administrator Guide.

Request SyntaxGET /phone-numbers-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken&phoneNumberCountryCodes=PhoneNumberCountryCodes&phoneNumberTypes=PhoneNumberTypes HTTP/1.1


InstanceId (p. 44)





Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 44)


PhoneNumberCountryCodes (p. 44)

The ISO country code.


Valid Values: AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU |AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW |BR | IO | VG | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL |CN | CX | CC | CO | KM | CK | CR | HR | CU | CW | CY | CZ | CD | DK | DJ |DM | DO | TL | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR |PF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GU | GT | GG | GN | GW |GY | HT | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI |JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY |LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MR | MU | YT |MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN |NC | NZ | NI | NE | NG | NU | KP | MP | NO | OM | PK | PW | PA | PG | PY |PE | PH | PN | PL | PT | PR | QA | CG | RE | RO | RU | RW | BL | SH | KN |LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK |SI | SB | SO | ZA | KR | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW |TJ | TZ | TH | TG | TK | TO | TT | TN | TR | TM | TC | TV | VI | UG | UA |AE | GB | US | UY | UZ | VU | VA | VE | VN | WF | EH | YE | ZM | ZW


https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html


PhoneNumberTypes (p. 44)

The type of phone number.


Valid Values: TOLL_FREE | DID



{ "NextToken": "string", "PhoneNumberSummaryList": [ { "Arn": "string", "Id": "string", "PhoneNumber": "string", "PhoneNumberCountryCode": "string", "PhoneNumberType": "string" } ]}



NextToken (p. 45)


Type: StringPhoneNumberSummaryList (p. 45)

Information about the phone numbers.

Type: Array of PhoneNumberSummary (p. 112) objects



















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/ListPhoneNumbers

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/ListPhoneNumbers

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListPhoneNumbers

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ListPhoneNumbers

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ListPhoneNumbers

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/ListPhoneNumbers

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListPhoneNumbers

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListPhoneNumbers

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListPhoneNumbers

Amazon Connect Service API ReferenceListQueues

ListQueuesProvides information about the queues for the specified Amazon Connect instance.

For more information about queues, see Queues: Standard and Agent in the Amazon ConnectAdministrator Guide.

Request SyntaxGET /queues-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken&queueTypes=QueueTypes HTTP/1.1


InstanceId (p. 47)







QueueTypes (p. 47)

The type of queue.


Valid Values: STANDARD | AGENT



{ "NextToken": "string", "QueueSummaryList": [ { "Arn": "string", "Id": "string",


https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html


"Name": "string", "QueueType": "string" } ]}



NextToken (p. 47)


Type: StringQueueSummaryList (p. 47)

Information about the queues.

Type: Array of QueueSummary (p. 115) objects


















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/ListQueues

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/ListQueues

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListQueues

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ListQueues

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ListQueues

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/ListQueues

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListQueues

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListQueues

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListQueues

Amazon Connect Service API ReferenceListRoutingProfiles

ListRoutingProfilesProvides summary information about the routing profiles for the specified Amazon Connect instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in theAmazon Connect Administrator Guide.

Request SyntaxGET /routing-profiles-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1


InstanceId (p. 50)









{ "NextToken": "string", "RoutingProfileSummaryList": [ { "Arn": "string", "Id": "string", "Name": "string" } ]}



https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html

https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html



NextToken (p. 50)


Type: StringRoutingProfileSummaryList (p. 50)

Information about the routing profiles.

Type: Array of RoutingProfileSummary (p. 116) objects














• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3


https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/ListRoutingProfiles

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/ListRoutingProfiles

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListRoutingProfiles

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ListRoutingProfiles

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ListRoutingProfiles

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/ListRoutingProfiles

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListRoutingProfiles


• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListRoutingProfiles

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListRoutingProfiles

Amazon Connect Service API ReferenceListSecurityProfiles

ListSecurityProfilesProvides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect AdministratorGuide.

Request SyntaxGET /security-profiles-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1


InstanceId (p. 53)



Required: Yes

MaxResults (p. 53)



NextToken (p. 53)




{ "NextToken": "string", "SecurityProfileSummaryList": [ { "Arn": "string", "Id": "string", "Name": "string" } ]}


https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html




NextToken (p. 53)


Type: StringSecurityProfileSummaryList (p. 53)

Information about the security profiles.

Type: Array of SecurityProfileSummary (p. 117) objects
















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/ListSecurityProfiles

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/ListSecurityProfiles

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListSecurityProfiles

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ListSecurityProfiles




https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ListSecurityProfiles

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/ListSecurityProfiles

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListSecurityProfiles

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListSecurityProfiles

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListSecurityProfiles

Amazon Connect Service API ReferenceListTagsForResource

ListTagsForResourceLists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the AmazonConnect Administrator Guide.

Request SyntaxGET /tags/resourceArn HTTP/1.1


resourceArn (p. 56)

The Amazon Resource Name (ARN) of the resource.

Required: Yes



{ "tags": { "string" : "string" }}



tags (p. 56)

Information about the tags.






https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html


















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/ListTagsForResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ListTagsForResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListTagsForResource

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListTagsForResource

Amazon Connect Service API ReferenceListUserHierarchyGroups

ListUserHierarchyGroupsProvides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon ConnectAdministrator Guide.

Request SyntaxGET /user-hierarchy-groups-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1


InstanceId (p. 58)



Required: Yes

MaxResults (p. 58)



NextToken (p. 58)




{ "NextToken": "string", "UserHierarchyGroupSummaryList": [ { "Arn": "string", "Id": "string", "Name": "string" } ]}


https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html




NextToken (p. 58)


Type: StringUserHierarchyGroupSummaryList (p. 58)

Information about the hierarchy groups.

Type: Array of HierarchyGroupSummary (p. 102) objects
















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/ListUserHierarchyGroups

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/ListUserHierarchyGroups

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListUserHierarchyGroups

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ListUserHierarchyGroups




https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ListUserHierarchyGroups

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/ListUserHierarchyGroups

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListUserHierarchyGroups

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListUserHierarchyGroups

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListUserHierarchyGroups

Amazon Connect Service API ReferenceListUsers

ListUsersProvides summary information about the users for the specified Amazon Connect instance.

Request SyntaxGET /users-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1


InstanceId (p. 61)









{ "NextToken": "string", "UserSummaryList": [ { "Arn": "string", "Id": "string", "Username": "string" } ]}





NextToken (p. 61)


Type: StringUserSummaryList (p. 61)

Information about the users.

Type: Array of UserSummary (p. 123) objects














• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3


https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/ListUsers

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/ListUsers

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListUsers

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ListUsers

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ListUsers

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/ListUsers

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListUsers


• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListUsers

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListUsers

Amazon Connect Service API ReferenceStartChatContact

StartChatContactInitiates a contact flow to start a new chat for the customer. Response of this API provides a tokenrequired to obtain credentials from the CreateParticipantConnection API in the Amazon ConnectParticipant Service.

When a new chat contact is successfully created, clients need to subscribe to the participant’s connectionfor the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection withWEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in two situations:

• API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the APIGateway.

• The quota for concurrent active chats is exceeded. Active chat throttling returns aLimitExceededException.

For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.

Request SyntaxPUT /contact/chat HTTP/1.1Content-type: application/json

{ "Attributes": { "string" : "string" }, "ClientToken": "string", "ContactFlowId": "string", "InitialMessage": { "Content": "string", "ContentType": "string" }, "InstanceId": "string", "ParticipantDetails": { "DisplayName": "string" }}

URI Request ParametersThe request does not use any URI parameters.


Attributes (p. 64)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connectattributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys caninclude only alphanumeric, dash, and underscore characters.


https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html



https://docs.aws.amazon.com/connect/latest/adminguide/chat.html





Required: NoClientToken (p. 64)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Length Constraints: Maximum length of 500.

Required: NoContactFlowId (p. 64)

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the AmazonConnect console user interface, on the navigation menu go to Routing, Contact Flows. Choosethe contact flow. On the contact flow page, under the name of the contact flow, choose Showadditional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

Type: String


Required: YesInitialMessage (p. 64)

The initial message to be sent to the newly created chat.

Type: ChatMessage (p. 93) object

Required: NoInstanceId (p. 64)


Type: String


Required: YesParticipantDetails (p. 64)

Information identifying the participant.

Type: ParticipantDetails (p. 111) object

Required: Yes




Content-type: application/json

{ "ContactId": "string", "ParticipantId": "string", "ParticipantToken": "string"}



ContactId (p. 65)

The identifier of this contact within the Amazon Connect instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.ParticipantId (p. 65)

The identifier for a chat participant. The participantId for a chat participant is the same throughoutthe chat lifecycle.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.ParticipantToken (p. 65)

The token used by the chat participant to call CreateParticipantConnection. The participant token isvalid for the lifetime of a chat participant.

Type: String













LimitExceededException








https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/StartChatContact

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/StartChatContact

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartChatContact

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/StartChatContact

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/StartChatContact

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/StartChatContact

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartChatContact

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartChatContact

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartChatContact

Amazon Connect Service API ReferenceStartOutboundVoiceContact

StartOutboundVoiceContactThis API places an outbound call to a contact, and then initiates the contact flow. It performs the actionsin the contact flow that's specified (in ContactFlowId).

Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flowplaces an outbound call to a contact, and then puts the contact in queue, that's when the call is routed tothe agent, like any other inbound case.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, itfails.

NoteUK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobilenumbers, you must submit a service quota increase request. For more information, see AmazonConnect Service Quotas in the Amazon Connect Administrator Guide.

Request SyntaxPUT /contact/outbound-voice HTTP/1.1Content-type: application/json

{ "Attributes": { "string" : "string" }, "ClientToken": "string", "ContactFlowId": "string", "DestinationPhoneNumber": "string", "InstanceId": "string", "QueueId": "string", "SourcePhoneNumber": "string"}



Attributes (p. 68)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connectattributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys caninclude only alphanumeric, dash, and underscore characters.




Required: No





ClientToken (p. 68)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Thetoken is valid for 7 days after creation. If a contact is already started, the contact ID is returned. Ifthe contact is disconnected, a new contact is started.

Type: String


Required: NoContactFlowId (p. 68)

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the AmazonConnect console user interface, on the navigation menu go to Routing, Contact Flows. Choosethe contact flow. On the contact flow page, under the name of the contact flow, choose Showadditional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

Type: String


Required: YesDestinationPhoneNumber (p. 68)

The phone number of the customer, in E.164 format.

Type: String



Type: String


Required: YesQueueId (p. 68)

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone numberspecified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. Ifyou do not specify a queue, you must specify a source phone number.

Type: String

Required: NoSourcePhoneNumber (p. 68)

The phone number associated with the Amazon Connect instance, in E.164 format. If you do notspecify a source phone number, you must specify a queue.

Type: String

Required: No




{ "ContactId": "string"}



ContactId (p. 70)

The identifier of this contact within the Amazon Connect instance.

Type: String



DestinationNotAllowedException

Outbound calls to the destination number are not allowed.







HTTP Status Code: 400LimitExceededException


HTTP Status Code: 429OutboundContactNotPermittedException

The contact is not permitted.









https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/StartOutboundVoiceContact

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/StartOutboundVoiceContact

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartOutboundVoiceContact

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/StartOutboundVoiceContact

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/StartOutboundVoiceContact

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/StartOutboundVoiceContact

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartOutboundVoiceContact

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartOutboundVoiceContact

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartOutboundVoiceContact

Amazon Connect Service API ReferenceStopContact

StopContactEnds the specified contact.

Request SyntaxPOST /contact/stop HTTP/1.1Content-type: application/json

{ "ContactId": "string", "InstanceId": "string"}



ContactId (p. 72)

The ID of the contact.

Type: String




Type: String


Required: Yes






ContactNotFoundException

The contact with the specified ID is not active or does not exist.













https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/StopContact

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/StopContact

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StopContact

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/StopContact

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/StopContact

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/StopContact

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StopContact

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StopContact

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StopContact

Amazon Connect Service API ReferenceTagResource

TagResourceAdds the specified tags to the specified resource.

The supported resource type is users.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the AmazonConnect Administrator Guide.

Request SyntaxPOST /tags/resourceArn HTTP/1.1Content-type: application/json

{ "tags": { "string" : "string" }}


resourceArn (p. 74)


Required: Yes


tags (p. 74)

One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.






Required: Yes



https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html


















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/TagResource

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/TagResource

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/TagResource

Amazon Connect Service API ReferenceUntagResource

UntagResourceRemoves the specified tags from the specified resource.

Request SyntaxDELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1


resourceArn (p. 76)


Required: Yes

tagKeys (p. 76)

The tag keys.



Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Required: Yes






















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UntagResource

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UntagResource

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UntagResource

Amazon Connect Service API ReferenceUpdateContactAttributes

UpdateContactAttributesCreates or updates the contact attributes associated with the specified contact.

You can add or update attributes for both ongoing and completed contacts. For example, you can updatethe customer's name or the reason the customer called while the call is active, or add notes about stepsthat the agent took during the call that are displayed to the next agent that takes the call. You can alsoupdate attributes for a contact using data from your CRM application and save the data with the contactin Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifyingabusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Important: You cannot use the operation to update attributes for contacts that occurred prior to therelease of the API, September 12, 2018. You can update attributes only for contacts that started afterthe release of the API. If you attempt to update attributes for a contact that occurred prior to the releaseof the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to therelease of the API but are still active in your instance.

Request SyntaxPOST /contact/attributes HTTP/1.1Content-type: application/json

{ "Attributes": { "string" : "string" }, "InitialContactId": "string", "InstanceId": "string"}



Attributes (p. 78)

The Amazon Connect attributes. These attributes can be accessed in contact flows just like any othercontact attributes.

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can includeonly alphanumeric, dash, and underscore characters.




Required: Yes



InitialContactId (p. 78)

The identifier of the contact. This is the identifier of the contact associated with the first interactionwith the contact center.

Type: String




Type: String


Required: Yes


















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/UpdateContactAttributes

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/UpdateContactAttributes

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactAttributes

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UpdateContactAttributes

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UpdateContactAttributes

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/UpdateContactAttributes

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactAttributes

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactAttributes

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactAttributes

Amazon Connect Service API ReferenceUpdateUserHierarchy

UpdateUserHierarchyAssigns the specified hierarchy group to the specified user.

Request SyntaxPOST /users/InstanceId/UserId/hierarchy HTTP/1.1Content-type: application/json

{ "HierarchyGroupId": "string"}


InstanceId (p. 81)





Required: Yes


HierarchyGroupId (p. 81)


Type: String

Required: No




















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/UpdateUserHierarchy

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/UpdateUserHierarchy

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserHierarchy

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UpdateUserHierarchy

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UpdateUserHierarchy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/UpdateUserHierarchy

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserHierarchy

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserHierarchy

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserHierarchy

Amazon Connect Service API ReferenceUpdateUserIdentityInfo

UpdateUserIdentityInfoUpdates the identity information for the specified user.

ImportantSomeone with the ability to invoke UpdateUserIndentityInfo can change the logincredentials of other users by changing their email address. This poses a security risk to yourorganization. They can change the email address of a user to the attacker's email address, andthen reset the password through email. We strongly recommend limiting who has the abilityto invoke UpdateUserIndentityInfo. For more information, see Best Practices for SecurityProfiles in the Amazon Connect Administrator Guide.

Request Syntax

POST /users/InstanceId/UserId/identity-info HTTP/1.1Content-type: application/json

{ "IdentityInfo": { "Email": "string", "FirstName": "string", "LastName": "string" }}


InstanceId (p. 83)



Required: Yes

UserId (p. 83)


Required: Yes


IdentityInfo (p. 83)

The identity information for the user.


Required: Yes


https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html

https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html



















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/UpdateUserIdentityInfo

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/UpdateUserIdentityInfo

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserIdentityInfo

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UpdateUserIdentityInfo

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UpdateUserIdentityInfo

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/UpdateUserIdentityInfo

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserIdentityInfo

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserIdentityInfo

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserIdentityInfo

Amazon Connect Service API ReferenceUpdateUserPhoneConfig

UpdateUserPhoneConfigUpdates the phone configuration settings for the specified user.

Request SyntaxPOST /users/InstanceId/UserId/phone-config HTTP/1.1Content-type: application/json

{ "PhoneConfig": { "AfterContactWorkTimeLimit": number, "AutoAccept": boolean, "DeskPhoneNumber": "string", "PhoneType": "string" }}


InstanceId (p. 86)





Required: Yes


PhoneConfig (p. 86)

Information about phone configuration settings for the user.


Required: Yes




















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/UpdateUserPhoneConfig

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/UpdateUserPhoneConfig

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserPhoneConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UpdateUserPhoneConfig

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UpdateUserPhoneConfig

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/UpdateUserPhoneConfig

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserPhoneConfig

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserPhoneConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserPhoneConfig

Amazon Connect Service API ReferenceUpdateUserRoutingProfile

UpdateUserRoutingProfileAssigns the specified routing profile to the specified user.

Request SyntaxPOST /users/InstanceId/UserId/routing-profile HTTP/1.1Content-type: application/json

{ "RoutingProfileId": "string"}


InstanceId (p. 88)





Required: Yes


RoutingProfileId (p. 88)


Type: String

Required: Yes




















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/UpdateUserRoutingProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/UpdateUserRoutingProfile

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserRoutingProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UpdateUserRoutingProfile

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UpdateUserRoutingProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/UpdateUserRoutingProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserRoutingProfile

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserRoutingProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserRoutingProfile

Amazon Connect Service API ReferenceUpdateUserSecurityProfiles

UpdateUserSecurityProfilesAssigns the specified security profiles to the specified user.

Request SyntaxPOST /users/InstanceId/UserId/security-profiles HTTP/1.1Content-type: application/json

{ "SecurityProfileIds": [ "string" ]}


InstanceId (p. 90)





Required: Yes


SecurityProfileIds (p. 90)

The identifiers of the security profiles for the user.



Required: Yes




















https://docs.aws.amazon.com/goto/aws-cli/connect-2017-08-08/UpdateUserSecurityProfiles

https://docs.aws.amazon.com/goto/DotNetSDKV3/connect-2017-08-08/UpdateUserSecurityProfiles

https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserSecurityProfiles

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UpdateUserSecurityProfiles

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UpdateUserSecurityProfiles

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/connect-2017-08-08/UpdateUserSecurityProfiles

https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserSecurityProfiles

https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserSecurityProfiles

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserSecurityProfiles


Data TypesThe Amazon Connect Service API contains several data types that various actions use. This sectiondescribes each data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• ChatMessage (p. 93)• ContactFlowSummary (p. 94)• Credentials (p. 95)• CurrentMetric (p. 96)• CurrentMetricData (p. 97)• CurrentMetricResult (p. 98)• Dimensions (p. 99)• Filters (p. 100)• HierarchyGroup (p. 101)• HierarchyGroupSummary (p. 102)• HierarchyLevel (p. 103)• HierarchyPath (p. 104)• HierarchyStructure (p. 105)• HistoricalMetric (p. 106)• HistoricalMetricData (p. 108)• HistoricalMetricResult (p. 109)• HoursOfOperationSummary (p. 110)• ParticipantDetails (p. 111)• PhoneNumberSummary (p. 112)• QueueReference (p. 114)• QueueSummary (p. 115)• RoutingProfileSummary (p. 116)• SecurityProfileSummary (p. 117)• Threshold (p. 118)• User (p. 119)• UserIdentityInfo (p. 121)• UserPhoneConfig (p. 122)• UserSummary (p. 123)


Amazon Connect Service API ReferenceChatMessage

ChatMessageA chat message.

ContentsContent

The content of the chat message.

Type: String


Required: YesContentType

The type of the content. Supported types are text/plain.

Type: String


Required: Yes


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ChatMessage

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ChatMessage

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ChatMessage

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ChatMessage

Amazon Connect Service API ReferenceContactFlowSummary

ContactFlowSummaryContains summary information about a contact flow.

ContentsArn

The Amazon Resource Name (ARN) of the contact flow.

Type: String

Required: NoContactFlowType

The type of contact flow.

Type: String

Valid Values: CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER| AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER |QUEUE_TRANSFER

Required: NoId

The identifier of the contact flow.

Type: String


Required: NoName

The name of the contact flow.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ContactFlowSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ContactFlowSummary

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ContactFlowSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ContactFlowSummary

Amazon Connect Service API ReferenceCredentials

CredentialsContains credentials to use for federation.

ContentsAccessToken

An access token generated for a federated user to access Amazon Connect.

Type: String

Required: NoAccessTokenExpiration

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

Type: Timestamp

Required: NoRefreshToken

Renews a token generated for a user to access the Amazon Connect instance.

Type: String

Required: NoRefreshTokenExpiration

Renews the expiration timer for a generated token.

Type: Timestamp

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/Credentials

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/Credentials

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/Credentials

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/Credentials

Amazon Connect Service API ReferenceCurrentMetric

CurrentMetricContains information about a real-time metric. For a description of each metric, see Real-time MetricsDefinitions in the Amazon Connect Administrator Guide.

ContentsName

The name of the metric.

Type: String

Valid Values: AGENTS_ONLINE | AGENTS_AVAILABLE | AGENTS_ON_CALL |AGENTS_NON_PRODUCTIVE | AGENTS_AFTER_CONTACT_WORK | AGENTS_ERROR |AGENTS_STAFFED | CONTACTS_IN_QUEUE | OLDEST_CONTACT_AGE | CONTACTS_SCHEDULED| AGENTS_ON_CONTACT | SLOTS_ACTIVE | SLOTS_AVAILABLE

Required: NoUnit

The unit for the metric.

Type: String

Valid Values: SECONDS | COUNT | PERCENT

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CurrentMetric

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/CurrentMetric

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/CurrentMetric

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CurrentMetric

Amazon Connect Service API ReferenceCurrentMetricData

CurrentMetricDataContains the data for a real-time metric.

ContentsMetric

Information about the metric.

Type: CurrentMetric (p. 96) object

Required: NoValue

The value of the metric.

Type: Double

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CurrentMetricData

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/CurrentMetricData

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/CurrentMetricData

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CurrentMetricData

Amazon Connect Service API ReferenceCurrentMetricResult

CurrentMetricResultContains information about a set of real-time metrics.

ContentsCollections

The set of metrics.

Type: Array of CurrentMetricData (p. 97) objects

Required: NoDimensions

The dimensions for the metrics.

Type: Dimensions (p. 99) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CurrentMetricResult

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/CurrentMetricResult

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/CurrentMetricResult

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CurrentMetricResult

Amazon Connect Service API ReferenceDimensions

DimensionsContains information about the dimensions for a set of metrics.

ContentsChannel

The channel used for grouping and filters.

Type: String

Valid Values: VOICE | CHAT

Required: NoQueue

Information about the queue for which metrics are returned.

Type: QueueReference (p. 114) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/Dimensions

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/Dimensions

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/Dimensions

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/Dimensions

Amazon Connect Service API ReferenceFilters

FiltersContains the filter to apply when retrieving metrics.

ContentsChannels

The channel to use to filter the metrics.


Array Members: Maximum number of 1 item.

Valid Values: VOICE | CHAT

Required: NoQueues

The queues to use to filter the metrics. You can specify up to 100 queues per request.



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/Filters

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/Filters

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/Filters

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/Filters

Amazon Connect Service API ReferenceHierarchyGroup

HierarchyGroupContains information about a hierarchy group.

ContentsArn

The Amazon Resource Name (ARN) of the hierarchy group.

Type: String

Required: NoHierarchyPath

Information about the levels in the hierarchy group.

Type: HierarchyPath (p. 104) object

Required: NoId


Type: String

Required: NoLevelId

The identifier of the level in the hierarchy group.

Type: String

Required: NoName

The name of the hierarchy group.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/HierarchyGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/HierarchyGroup

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/HierarchyGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/HierarchyGroup

Amazon Connect Service API ReferenceHierarchyGroupSummary

HierarchyGroupSummaryContains summary information about a hierarchy group.

ContentsArn

The Amazon Resource Name (ARN) of the hierarchy group.

Type: String

Required: NoId


Type: String

Required: NoName

The name of the hierarchy group.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/HierarchyGroupSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/HierarchyGroupSummary

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/HierarchyGroupSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/HierarchyGroupSummary

Amazon Connect Service API ReferenceHierarchyLevel

HierarchyLevelContains information about a hierarchy level.

ContentsArn

The Amazon Resource Name (ARN) of the hierarchy level.

Type: String

Required: NoId

The identifier of the hierarchy level.

Type: String

Required: NoName

The name of the hierarchy level.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/HierarchyLevel

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/HierarchyLevel

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/HierarchyLevel

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/HierarchyLevel

Amazon Connect Service API ReferenceHierarchyPath

HierarchyPathContains information about the levels of a hierarchy group.

ContentsLevelFive

Information about level five.

Type: HierarchyGroupSummary (p. 102) object

Required: NoLevelFour

Information about level four.


Required: NoLevelOne

Information about level one.


Required: NoLevelThree

Information about level three.


Required: NoLevelTwo

Information about level two.


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/HierarchyPath

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/HierarchyPath

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/HierarchyPath

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/HierarchyPath

Amazon Connect Service API ReferenceHierarchyStructure

HierarchyStructureContains information about a hierarchy structure.

ContentsLevelFive

Information about level five.

Type: HierarchyLevel (p. 103) object

Required: NoLevelFour

Information about level four.


Required: NoLevelOne

Information about level one.


Required: NoLevelThree

Information about level three.


Required: NoLevelTwo

Information about level two.


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/HierarchyStructure

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/HierarchyStructure

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/HierarchyStructure

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/HierarchyStructure

Amazon Connect Service API ReferenceHistoricalMetric

HistoricalMetricContains information about a historical metric. For a description of each metric, see Historical MetricsDefinitions in the Amazon Connect Administrator Guide.

ContentsName

The name of the metric.

Type: String

Valid Values: CONTACTS_QUEUED | CONTACTS_HANDLED | CONTACTS_ABANDONED| CONTACTS_CONSULTED | CONTACTS_AGENT_HUNG_UP_FIRST |CONTACTS_HANDLED_INCOMING | CONTACTS_HANDLED_OUTBOUND |CONTACTS_HOLD_ABANDONS | CONTACTS_TRANSFERRED_IN | CONTACTS_TRANSFERRED_OUT| CONTACTS_TRANSFERRED_IN_FROM_QUEUE | CONTACTS_TRANSFERRED_OUT_FROM_QUEUE| CONTACTS_MISSED | CALLBACK_CONTACTS_HANDLED | API_CONTACTS_HANDLED| OCCUPANCY | HANDLE_TIME | AFTER_CONTACT_WORK_TIME | QUEUED_TIME| ABANDON_TIME | QUEUE_ANSWER_TIME | HOLD_TIME | INTERACTION_TIME |INTERACTION_AND_HOLD_TIME | SERVICE_LEVEL

Required: NoStatistic

The statistic for the metric.

Type: String

Valid Values: SUM | MAX | AVG

Required: NoThreshold

The threshold for the metric, used with service level metrics.

Type: Threshold (p. 118) object

Required: NoUnit

The unit for the metric.

Type: String

Valid Values: SECONDS | COUNT | PERCENT

Required: No


• AWS SDK for C++• AWS SDK for Go




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/HistoricalMetric

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/HistoricalMetric


• AWS SDK for Java• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/HistoricalMetric

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/HistoricalMetric

Amazon Connect Service API ReferenceHistoricalMetricData

HistoricalMetricDataContains the data for a historical metric.

ContentsMetric

Information about the metric.

Type: HistoricalMetric (p. 106) object

Required: NoValue

The value of the metric.

Type: Double

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/HistoricalMetricData

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/HistoricalMetricData

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/HistoricalMetricData

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/HistoricalMetricData

Amazon Connect Service API ReferenceHistoricalMetricResult

HistoricalMetricResultContains information about the historical metrics retrieved.

ContentsCollections

The set of metrics.

Type: Array of HistoricalMetricData (p. 108) objects

Required: NoDimensions

The dimension for the metrics.

Type: Dimensions (p. 99) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/HistoricalMetricResult

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/HistoricalMetricResult

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/HistoricalMetricResult

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/HistoricalMetricResult

Amazon Connect Service API ReferenceHoursOfOperationSummary

HoursOfOperationSummaryContains summary information about hours of operation for a contact center.

ContentsArn

The Amazon Resource Name (ARN) of the hours of operation.

Type: String

Required: NoId

The identifier of the hours of operation.

Type: String

Required: NoName

The name of the hours of operation.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/HoursOfOperationSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/HoursOfOperationSummary

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/HoursOfOperationSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/HoursOfOperationSummary

Amazon Connect Service API ReferenceParticipantDetails

ParticipantDetailsThe customer's details.

ContentsDisplayName

Display name of the participant.

Type: String


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ParticipantDetails

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/ParticipantDetails

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/ParticipantDetails

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ParticipantDetails

Amazon Connect Service API ReferencePhoneNumberSummary

PhoneNumberSummaryContains summary information about a phone number for a contact center.

ContentsArn

The Amazon Resource Name (ARN) of the phone number.

Type: String

Required: NoId

The identifier of the phone number.

Type: String

Required: NoPhoneNumber

The phone number.

Type: String

Required: NoPhoneNumberCountryCode

The ISO country code.

Type: String

Valid Values: AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU |AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW |BR | IO | VG | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL |CN | CX | CC | CO | KM | CK | CR | HR | CU | CW | CY | CZ | CD | DK | DJ |DM | DO | TL | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR |PF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GU | GT | GG | GN | GW |GY | HT | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI |JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY |LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MR | MU | YT |MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN |NC | NZ | NI | NE | NG | NU | KP | MP | NO | OM | PK | PW | PA | PG | PY |PE | PH | PN | PL | PT | PR | QA | CG | RE | RO | RU | RW | BL | SH | KN |LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK |SI | SB | SO | ZA | KR | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW |TJ | TZ | TH | TG | TK | TO | TT | TN | TR | TM | TC | TV | VI | UG | UA |AE | GB | US | UY | UZ | VU | VA | VE | VN | WF | EH | YE | ZM | ZW

Required: NoPhoneNumberType

The type of phone number.

Type: String

Valid Values: TOLL_FREE | DID



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/PhoneNumberSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/PhoneNumberSummary

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/PhoneNumberSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/PhoneNumberSummary

Amazon Connect Service API ReferenceQueueReference

QueueReferenceContains information about a queue resource for which metrics are returned.

ContentsArn

The Amazon Resource Name (ARN) of the queue.

Type: String

Required: NoId

The identifier of the queue.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/QueueReference

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/QueueReference

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/QueueReference

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/QueueReference

Amazon Connect Service API ReferenceQueueSummary

QueueSummaryContains summary information about a queue.

ContentsArn

The Amazon Resource Name (ARN) of the queue.

Type: String

Required: NoId

The identifier of the queue.

Type: String

Required: NoName

The name of the queue.

Type: String


Required: NoQueueType

The type of queue.

Type: String

Valid Values: STANDARD | AGENT

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/QueueSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/QueueSummary

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/QueueSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/QueueSummary

Amazon Connect Service API ReferenceRoutingProfileSummary

RoutingProfileSummaryContains summary information about a routing profile.

ContentsArn

The Amazon Resource Name (ARN) of the routing profile.

Type: String

Required: NoId

The identifier of the routing profile.

Type: String

Required: NoName

The name of the routing profile.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/RoutingProfileSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/RoutingProfileSummary

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/RoutingProfileSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/RoutingProfileSummary

Amazon Connect Service API ReferenceSecurityProfileSummary

SecurityProfileSummaryContains information about a security profile.

ContentsArn

The Amazon Resource Name (ARN) of the security profile.

Type: String

Required: NoId

The identifier of the security profile.

Type: String

Required: NoName

The name of the security profile.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SecurityProfileSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/SecurityProfileSummary

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/SecurityProfileSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SecurityProfileSummary

Amazon Connect Service API ReferenceThreshold

ThresholdContains information about the threshold for service level metrics.

ContentsComparison

The type of comparison. Only "less than" (LT) comparisons are supported.

Type: String

Valid Values: LT

Required: NoThresholdValue

The threshold value to compare.

Type: Double

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/Threshold

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/Threshold

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/Threshold

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/Threshold

Amazon Connect Service API ReferenceUser

UserContains information about a user account for a Amazon Connect instance.

ContentsArn


Type: String

Required: NoDirectoryUserId

The identifier of the user account in the directory used for identity management.

Type: String

Required: NoHierarchyGroupId

The identifier of the hierarchy group for the user.

Type: String

Required: NoId


Type: String

Required: NoIdentityInfo

Information about the user identity.


Required: NoPhoneConfig

Information about the phone configuration for the user.


Required: NoRoutingProfileId


Type: String

Required: NoSecurityProfileIds

The identifiers of the security profiles for the user.





Required: NoTags

The tags.






Required: NoUsername

The user name assigned to the user account.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/User

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/User

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/User

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/User

Amazon Connect Service API ReferenceUserIdentityInfo

UserIdentityInfoContains information about the identity of a user.

ContentsEmail

The email address. If you are using SAML for identity management and include this parameter, anerror is returned.

Type: String

Required: NoFirstName

The first name. This is required if you are using Amazon Connect or SAML for identity management.

Type: String


Required: NoLastName

The last name. This is required if you are using Amazon Connect or SAML for identity management.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UserIdentityInfo

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UserIdentityInfo

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UserIdentityInfo

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UserIdentityInfo

Amazon Connect Service API ReferenceUserPhoneConfig

UserPhoneConfigContains information about the phone configuration settings for a user.

ContentsAfterContactWorkTimeLimit

The After Call Work (ACW) timeout setting, in seconds.

Type: Integer

Valid Range: Minimum value of 0.

Required: NoAutoAccept

The Auto accept setting.

Type: Boolean

Required: NoDeskPhoneNumber

The phone number for the user's desk phone.

Type: String

Required: NoPhoneType

The phone type.

Type: String

Valid Values: SOFT_PHONE | DESK_PHONE

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UserPhoneConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UserPhoneConfig

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UserPhoneConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UserPhoneConfig

Amazon Connect Service API ReferenceUserSummary

UserSummaryContains summary information about a user.

ContentsArn


Type: String

Required: NoId


Type: String

Required: NoUsername

The Amazon Connect user name of the user account.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UserSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/connect-2017-08-08/UserSummary

https://docs.aws.amazon.com/goto/SdkForJava/connect-2017-08-08/UserSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UserSummary


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.




MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.


The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



amazon connect serviceamazon connect service api reference welcome amazon connect is a cloud-based...

Documents