cognitect.aws.connect.docs.edn Maven / Gradle / Ivy
{:GetCurrentMetricData {:documentation "Gets the real-time metric data from the specified Amazon Connect instance.
For more information, see Real-time Metrics Reports in the Amazon Connect Administrator Guide.
", :request {:InstanceId string, :Filters {:Queues [:seq-of string], :Channels [:seq-of string]}, :Groupings [:seq-of string], :CurrentMetrics [:seq-of {:Name string, :Unit string}], :NextToken string, :MaxResults integer}, :required [:InstanceId :Filters :CurrentMetrics], :response {:NextToken string, :MetricResults [:seq-of {:Dimensions {:Queue {:Id string, :Arn string}, :Channel string}, :Collections [:seq-of {:Metric {:Name string, :Unit string}, :Value double}]}], :DataSnapshotTime timestamp}}, :ListRoutingProfiles {:documentation "Provides summary information about the routing profiles for the specified Amazon Connect instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:RoutingProfileSummaryList [:seq-of {:Id string, :Arn string, :Name string}], :NextToken string}}, :ListUserHierarchyGroups {:documentation "Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:UserHierarchyGroupSummaryList [:seq-of {:Id string, :Arn string, :Name string}], :NextToken string}}, :DescribeUserHierarchyStructure {:documentation "Describes the hierarchy structure of the specified Amazon Connect instance.
", :request {:InstanceId string}, :required [:InstanceId], :response {:HierarchyStructure {:LevelOne {:Id string, :Arn string, :Name string}, :LevelTwo {:Id string, :Arn string, :Name string}, :LevelThree {:Id string, :Arn string, :Name string}, :LevelFour {:Id string, :Arn string, :Name string}, :LevelFive {:Id string, :Arn string, :Name string}}}}, :ListHoursOfOperations {:documentation "Provides information about the hours of operation for the specified Amazon Connect instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:HoursOfOperationSummaryList [:seq-of {:Id string, :Arn string, :Name string}], :NextToken string}}, :StartOutboundVoiceContact {:documentation "Initiates a contact flow to place an outbound call to a customer.
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
", :request {:DestinationPhoneNumber string, :ContactFlowId string, :InstanceId string, :ClientToken string, :SourcePhoneNumber string, :QueueId string, :Attributes [:map-of string string]}, :required [:DestinationPhoneNumber :ContactFlowId :InstanceId], :response {:ContactId string}}, :ListQueues {:documentation "Provides information about the queues for the specified Amazon Connect instance.
", :request {:InstanceId string, :QueueTypes [:seq-of string], :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:QueueSummaryList [:seq-of {:Id string, :Arn string, :Name string, :QueueType string}], :NextToken string}}, :UpdateUserSecurityProfiles {:documentation "Assigns the specified security profiles to the specified user.
", :request {:SecurityProfileIds [:seq-of string], :UserId string, :InstanceId string}, :required [:SecurityProfileIds :UserId :InstanceId], :response nil}, :UpdateUserRoutingProfile {:documentation "Assigns the specified routing profile to the specified user.
", :request {:RoutingProfileId string, :UserId string, :InstanceId string}, :required [:RoutingProfileId :UserId :InstanceId], :response nil}, :UpdateContactAttributes {:documentation "Creates 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 update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive 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 the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
", :request {:InitialContactId string, :InstanceId string, :Attributes [:map-of string string]}, :required [:InitialContactId :InstanceId :Attributes], :response {}}, :StopContact {:documentation "Ends the specified contact.
", :request {:ContactId string, :InstanceId string}, :required [:ContactId :InstanceId], :response {}}, :GetContactAttributes {:documentation "Retrieves the contact attributes for the specified contact.
", :request {:InstanceId string, :InitialContactId string}, :required [:InstanceId :InitialContactId], :response {:Attributes [:map-of string string]}}, :UpdateUserPhoneConfig {:documentation "Updates the phone configuration settings for the specified user.
", :request {:PhoneConfig {:PhoneType string, :AutoAccept boolean, :AfterContactWorkTimeLimit integer, :DeskPhoneNumber string}, :UserId string, :InstanceId string}, :required [:PhoneConfig :UserId :InstanceId], :response nil}, :DescribeUserHierarchyGroup {:documentation "Describes the specified hierarchy group.
", :request {:HierarchyGroupId string, :InstanceId string}, :required [:HierarchyGroupId :InstanceId], :response {:HierarchyGroup {:Id string, :Arn string, :Name string, :LevelId string, :HierarchyPath {:LevelOne {:Id string, :Arn string, :Name string}, :LevelTwo {:Id string, :Arn string, :Name string}, :LevelThree {:Id string, :Arn string, :Name string}, :LevelFour {:Id string, :Arn string, :Name string}, :LevelFive {:Id string, :Arn string, :Name string}}}}}, :GetMetricData {:documentation "Gets historical metric data from the specified Amazon Connect instance.
For more information, see Historical Metrics Reports in the Amazon Connect Administrator Guide.
", :request {:InstanceId string, :StartTime timestamp, :EndTime timestamp, :Filters {:Queues [:seq-of string], :Channels [:seq-of string]}, :Groupings [:seq-of string], :HistoricalMetrics [:seq-of {:Name string, :Threshold {:Comparison string, :ThresholdValue double}, :Statistic string, :Unit string}], :NextToken string, :MaxResults integer}, :required [:InstanceId :StartTime :EndTime :Filters :HistoricalMetrics], :response {:NextToken string, :MetricResults [:seq-of {:Dimensions {:Queue {:Id string, :Arn string}, :Channel string}, :Collections [:seq-of {:Metric {:Name string, :Threshold {:Comparison string, :ThresholdValue double}, :Statistic string, :Unit string}, :Value double}]}]}}, :DeleteUser {:documentation "Deletes a user account from the specified Amazon Connect instance.
", :request {:InstanceId string, :UserId string}, :required [:InstanceId :UserId], :response nil}, :ListContactFlows {:documentation "Provides information about the contact flows for the specified Amazon Connect instance.
", :request {:InstanceId string, :ContactFlowTypes [:seq-of string], :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:ContactFlowSummaryList [:seq-of {:Id string, :Arn string, :Name string, :ContactFlowType string}], :NextToken string}}, :ListSecurityProfiles {:documentation "Provides summary information about the security profiles for the specified Amazon Connect instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:SecurityProfileSummaryList [:seq-of {:Id string, :Arn string, :Name string}], :NextToken string}}, :CreateUser {:documentation "Creates a user account for the specified Amazon Connect instance.
", :request {:IdentityInfo {:FirstName string, :LastName string, :Email string}, :SecurityProfileIds [:seq-of string], :InstanceId string, :DirectoryUserId string, :Password string, :RoutingProfileId string, :PhoneConfig {:PhoneType string, :AutoAccept boolean, :AfterContactWorkTimeLimit integer, :DeskPhoneNumber string}, :Username string, :HierarchyGroupId string}, :required [:Username :PhoneConfig :SecurityProfileIds :RoutingProfileId :InstanceId], :response {:UserId string, :UserArn string}}, :UpdateUserIdentityInfo {:documentation "Updates the identity information for the specified user.
", :request {:IdentityInfo {:FirstName string, :LastName string, :Email string}, :UserId string, :InstanceId string}, :required [:IdentityInfo :UserId :InstanceId], :response nil}, :ListUsers {:documentation "Provides summary information about the users for the specified Amazon Connect instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:UserSummaryList [:seq-of {:Id string, :Arn string, :Username string}], :NextToken string}}, :UpdateUserHierarchy {:documentation "Assigns the specified hierarchy group to the specified user.
", :request {:HierarchyGroupId string, :UserId string, :InstanceId string}, :required [:UserId :InstanceId], :response nil}, :DescribeUser {:documentation "Describes the specified user account.
", :request {:UserId string, :InstanceId string}, :required [:UserId :InstanceId], :response {:User {:IdentityInfo {:FirstName string, :LastName string, :Email string}, :SecurityProfileIds [:seq-of string], :Id string, :DirectoryUserId string, :RoutingProfileId string, :Arn string, :PhoneConfig {:PhoneType string, :AutoAccept boolean, :AfterContactWorkTimeLimit integer, :DeskPhoneNumber string}, :Username string, :HierarchyGroupId string}}}, :GetFederationToken {:documentation "Retrieves a token for federation.
", :request {:InstanceId string}, :required [:InstanceId], :response {:Credentials {:AccessToken string, :AccessTokenExpiration timestamp, :RefreshToken string, :RefreshTokenExpiration timestamp}}}, :ListPhoneNumbers {:documentation "Provides information about the phone numbers for the specified Amazon Connect instance.
", :request {:InstanceId string, :PhoneNumberTypes [:seq-of string], :PhoneNumberCountryCodes [:seq-of string], :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:PhoneNumberSummaryList [:seq-of {:Id string, :Arn string, :PhoneNumber string, :PhoneNumberType string, :PhoneNumberCountryCode string}], :NextToken string}}}