cognitect.aws.connect.docs.edn Maven / Gradle / Ivy
{:ListViewVersions {:documentation "Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
", :request {:InstanceId string, :ViewId string, :NextToken string, :MaxResults integer}, :required [:InstanceId :ViewId], :response {:ViewVersionSummaryList [:seq-of {:Id string, :Arn string, :Description string, :Name string, :Type [:one-of ["CUSTOMER_MANAGED" "AWS_MANAGED"]], :Version integer, :VersionDescription string}], :NextToken string}}, :DeleteQueue {:documentation "Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.
", :request {:InstanceId string, :QueueId string}, :required [:InstanceId :QueueId]}, :ListPhoneNumbersV2 {:documentation "Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
-
When given an instance ARN, ListPhoneNumbersV2
returns only the phone numbers claimed to the instance.
-
When given a traffic distribution group ARN ListPhoneNumbersV2
returns only the phone numbers claimed to the traffic distribution group.
", :request {:TargetArn string, :InstanceId string, :MaxResults integer, :NextToken string, :PhoneNumberCountryCodes [:seq-of [:one-of ["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"]]], :PhoneNumberTypes [:seq-of [:one-of ["TOLL_FREE" "DID" "UIFN" "SHARED" "THIRD_PARTY_TF" "THIRD_PARTY_DID" "SHORT_CODE"]]], :PhoneNumberPrefix string}, :response {:NextToken string, :ListPhoneNumbersSummaryList [:seq-of {:PhoneNumberId string, :PhoneNumberArn string, :PhoneNumberType [:one-of ["TOLL_FREE" "DID" "UIFN" "SHARED" "THIRD_PARTY_TF" "THIRD_PARTY_DID" "SHORT_CODE"]], :InstanceId string, :SourcePhoneNumberArn string, :PhoneNumberCountryCode [:one-of ["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"]], :PhoneNumber string, :PhoneNumberDescription string, :TargetArn string}]}}, :DescribeInstanceAttribute {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
", :request {:InstanceId string, :AttributeType [:one-of ["INBOUND_CALLS" "OUTBOUND_CALLS" "CONTACTFLOW_LOGS" "CONTACT_LENS" "AUTO_RESOLVE_BEST_VOICES" "USE_CUSTOM_TTS_VOICES" "EARLY_MEDIA" "MULTI_PARTY_CONFERENCE" "HIGH_VOLUME_OUTBOUND" "ENHANCED_CONTACT_MONITORING" "ENHANCED_CHAT_MONITORING"]]}, :required [:InstanceId :AttributeType], :response {:Attribute {:AttributeType [:one-of ["INBOUND_CALLS" "OUTBOUND_CALLS" "CONTACTFLOW_LOGS" "CONTACT_LENS" "AUTO_RESOLVE_BEST_VOICES" "USE_CUSTOM_TTS_VOICES" "EARLY_MEDIA" "MULTI_PARTY_CONFERENCE" "HIGH_VOLUME_OUTBOUND" "ENHANCED_CONTACT_MONITORING" "ENHANCED_CHAT_MONITORING"]], :Value string}}}, :StartContactRecording {:documentation "Starts recording the contact:
-
If the API is called before the agent joins the call, recording starts when the agent joins the call.
-
If the API is called after the agent joins the call, recording starts at the time of the API call.
StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
", :request {:InstanceId string, :ContactId string, :InitialContactId string, :VoiceRecordingConfiguration {:VoiceRecordingTrack [:one-of ["FROM_AGENT" "TO_AGENT" "ALL"]]}}, :required [:InstanceId :ContactId :InitialContactId :VoiceRecordingConfiguration]}, :CreateVocabulary {:documentation "Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
", :request {:ClientToken string, :InstanceId string, :VocabularyName string, :LanguageCode [:one-of ["ar-AE" "de-CH" "de-DE" "en-AB" "en-AU" "en-GB" "en-IE" "en-IN" "en-US" "en-WL" "es-ES" "es-US" "fr-CA" "fr-FR" "hi-IN" "it-IT" "ja-JP" "ko-KR" "pt-BR" "pt-PT" "zh-CN" "en-NZ" "en-ZA" "ca-ES" "da-DK" "fi-FI" "id-ID" "ms-MY" "nl-NL" "no-NO" "pl-PL" "sv-SE" "tl-PH"]], :Content string, :Tags [:map-of string string]}, :required [:InstanceId :VocabularyName :LanguageCode :Content], :response {:VocabularyArn string, :VocabularyId string, :State [:one-of ["CREATION_IN_PROGRESS" "ACTIVE" "CREATION_FAILED" "DELETE_IN_PROGRESS"]]}}, :DeleteRule {:documentation "Deletes a rule for the specified Amazon Connect instance.
", :request {:InstanceId string, :RuleId string}, :required [:InstanceId :RuleId]}, :CreateTaskTemplate {:documentation "Creates a new task template in the specified Amazon Connect instance.
", :request {:InstanceId string, :ContactFlowId string, :Constraints {:RequiredFields [:seq-of {:Id {:Name string}}], :ReadOnlyFields [:seq-of {:Id {:Name string}}], :InvisibleFields [:seq-of {:Id {:Name string}}]}, :Defaults {:DefaultFieldValues [:seq-of {:Id {:Name string}, :DefaultValue string}]}, :Name string, :Description string, :ClientToken string, :Fields [:seq-of {:Id {:Name string}, :Description string, :Type [:one-of ["NAME" "DESCRIPTION" "SCHEDULED_TIME" "QUICK_CONNECT" "URL" "NUMBER" "TEXT" "TEXT_AREA" "DATE_TIME" "BOOLEAN" "SINGLE_SELECT" "EMAIL"]], :SingleSelectOptions [:seq-of string]}], :Status [:one-of ["ACTIVE" "INACTIVE"]]}, :required [:InstanceId :Name :Fields], :response {:Id string, :Arn string}}, :DisassociateQueueQuickConnects {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
", :request {:InstanceId string, :QueueId string, :QuickConnectIds [:seq-of string]}, :required [:InstanceId :QueueId :QuickConnectIds]}, :SubmitContactEvaluation {:documentation "Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}
) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
", :request {:InstanceId string, :EvaluationId string, :Answers [:map-of string {:Value {:StringValue string, :NumericValue double, :NotApplicable boolean}}], :Notes [:map-of string {:Value string}]}, :required [:InstanceId :EvaluationId], :response {:EvaluationId string, :EvaluationArn string}}, :SearchUserHierarchyGroups {:documentation "Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with \"LevelId\": \"0\"
is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:AttributeFilter {:OrConditions [:seq-of {:TagConditions [:seq-of {:TagKey string, :TagValue string}]}], :AndCondition {:TagConditions [:seq-of {:TagKey string, :TagValue string}]}, :TagCondition {:TagKey string, :TagValue string}}}, :SearchCriteria shape/UserHierarchyGroupSearchCriteria}, :required [:InstanceId], :response {:UserHierarchyGroups [:seq-of {:Id string, :Arn string, :Name string, :LevelId string, :HierarchyPath {:LevelOne {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelTwo {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelThree {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelFour {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelFive {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}}, :Tags [:map-of string string], :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/UserHierarchyGroupSearchCriteria {:OrConditions [:seq-of shape/UserHierarchyGroupSearchCriteria], :AndConditions [:seq-of shape/UserHierarchyGroupSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}}, :CreatePrompt {:documentation "Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
", :request {:InstanceId string, :Name string, :Description string, :S3Uri string, :Tags [:map-of string string]}, :required [:InstanceId :Name :S3Uri], :response {:PromptARN string, :PromptId string}}, :CreateRoutingProfile {:documentation "Creates a new routing profile.
", :request {:InstanceId string, :Name string, :Description string, :DefaultOutboundQueueId string, :QueueConfigs [:seq-of {:QueueReference {:QueueId string, :Channel [:one-of ["VOICE" "CHAT" "TASK"]]}, :Priority integer, :Delay integer}], :MediaConcurrencies [:seq-of {:Channel [:one-of ["VOICE" "CHAT" "TASK"]], :Concurrency integer, :CrossChannelBehavior {:BehaviorType [:one-of ["ROUTE_CURRENT_CHANNEL_ONLY" "ROUTE_ANY_CHANNEL"]]}}], :Tags [:map-of string string], :AgentAvailabilityTimer [:one-of ["TIME_SINCE_LAST_ACTIVITY" "TIME_SINCE_LAST_INBOUND"]]}, :required [:InstanceId :Name :Description :DefaultOutboundQueueId :MediaConcurrencies], :response {:RoutingProfileArn string, :RoutingProfileId string}}, :SuspendContactRecording {:documentation "When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
", :request {:InstanceId string, :ContactId string, :InitialContactId string}, :required [:InstanceId :ContactId :InitialContactId]}, :DeletePredefinedAttribute {:documentation "Deletes a predefined attribute from the specified Amazon Connect instance.
", :request {:InstanceId string, :Name string}, :required [:InstanceId :Name]}, :SearchPredefinedAttributes {:documentation "Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchCriteria shape/PredefinedAttributeSearchCriteria}, :required [:InstanceId], :response {:PredefinedAttributes [:seq-of {:Name string, :Values {:StringList [:seq-of string]}, :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/PredefinedAttributeSearchCriteria {:OrConditions [:seq-of shape/PredefinedAttributeSearchCriteria], :AndConditions [:seq-of shape/PredefinedAttributeSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}}, :UpdateContactFlowModuleMetadata {:documentation "Updates metadata about specified flow module.
", :request {:InstanceId string, :ContactFlowModuleId string, :Name string, :Description string, :State [:one-of ["ACTIVE" "ARCHIVED"]]}, :required [:InstanceId :ContactFlowModuleId]}, :ActivateEvaluationForm {:documentation "Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
", :request {:InstanceId string, :EvaluationFormId string, :EvaluationFormVersion integer}, :required [:InstanceId :EvaluationFormId :EvaluationFormVersion], :response {:EvaluationFormId string, :EvaluationFormArn string, :EvaluationFormVersion integer}}, :ReleasePhoneNumber {:documentation "Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber
API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
", :request {:PhoneNumberId string, :ClientToken string}, :required [:PhoneNumberId]}, :ListTagsForResource {:documentation "Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
", :request {:resourceArn string}, :required [:resourceArn], :response {:tags [:map-of string string]}}, :CreateRule {:documentation "Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
", :request {:InstanceId string, :Name string, :TriggerEventSource {:EventSourceName [:one-of ["OnPostCallAnalysisAvailable" "OnRealTimeCallAnalysisAvailable" "OnRealTimeChatAnalysisAvailable" "OnPostChatAnalysisAvailable" "OnZendeskTicketCreate" "OnZendeskTicketStatusUpdate" "OnSalesforceCaseCreate" "OnContactEvaluationSubmit" "OnMetricDataUpdate" "OnCaseCreate" "OnCaseUpdate"]], :IntegrationAssociationId string}, :Function string, :Actions [:seq-of {:CreateCaseAction {:Fields [:seq-of {:Id string, :Value {:BooleanValue boolean, :DoubleValue double, :EmptyValue {}, :StringValue string}}], :TemplateId string}, :ActionType [:one-of ["CREATE_TASK" "ASSIGN_CONTACT_CATEGORY" "GENERATE_EVENTBRIDGE_EVENT" "SEND_NOTIFICATION" "CREATE_CASE" "UPDATE_CASE" "END_ASSOCIATED_TASKS" "SUBMIT_AUTO_EVALUATION"]], :SubmitAutoEvaluationAction {:EvaluationFormId string}, :EndAssociatedTasksAction {}, :UpdateCaseAction {:Fields [:seq-of {:Id string, :Value {:BooleanValue boolean, :DoubleValue double, :EmptyValue {}, :StringValue string}}]}, :EventBridgeAction {:Name string}, :TaskAction {:Name string, :Description string, :ContactFlowId string, :References [:map-of string {:Value string, :Type [:one-of ["URL" "ATTACHMENT" "NUMBER" "STRING" "DATE" "EMAIL"]]}]}, :AssignContactCategoryAction {}, :SendNotificationAction {:DeliveryMethod [:one-of ["EMAIL"]], :Subject string, :Content string, :ContentType [:one-of ["PLAIN_TEXT"]], :Recipient {:UserTags [:map-of string string], :UserIds [:seq-of string]}}}], :PublishStatus [:one-of ["DRAFT" "PUBLISHED"]], :ClientToken string}, :required [:InstanceId :Name :TriggerEventSource :Function :Actions :PublishStatus], :response {:RuleArn string, :RuleId string}}, :ListFlowAssociations {:documentation "List the flow association based on the filters.
", :request {:InstanceId string, :ResourceType [:one-of ["VOICE_PHONE_NUMBER"]], :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:FlowAssociationSummaryList [:seq-of {:ResourceId string, :FlowId string, :ResourceType [:one-of ["VOICE_PHONE_NUMBER"]]}], :NextToken string}}, :ListSecurityProfileApplications {:documentation "Returns a list of third-party applications in a specific security profile.
", :request {:SecurityProfileId string, :InstanceId string, :NextToken string, :MaxResults integer}, :required [:SecurityProfileId :InstanceId], :response {:Applications [:seq-of {:Namespace string, :ApplicationPermissions [:seq-of string]}], :NextToken string, :LastModifiedTime timestamp, :LastModifiedRegion string}}, :UpdateUserHierarchyStructure {:documentation "Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
", :request {:HierarchyStructure {:LevelOne {:Name string}, :LevelTwo {:Name string}, :LevelThree {:Name string}, :LevelFour {:Name string}, :LevelFive {:Name string}}, :InstanceId string}, :required [:HierarchyStructure :InstanceId]}, :CreateView {:documentation "Creates a new view with the possible status of SAVED
or PUBLISHED
.
The views will have a unique name for each connect instance.
It performs basic content validation if the status is SAVED
or full content validation if the status is set to PUBLISHED
. An error is returned if validation fails. It associates either the $SAVED
qualifier or both of the $SAVED
and $LATEST
qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.
", :request {:InstanceId string, :ClientToken string, :Status [:one-of ["PUBLISHED" "SAVED"]], :Content {:Template string, :Actions [:seq-of string]}, :Description string, :Name string, :Tags [:map-of string string]}, :required [:InstanceId :Status :Content :Name], :response {:View {:VersionDescription string, :LastModifiedTime timestamp, :ViewContentSha256 string, :Id string, :Tags [:map-of string string], :Arn string, :Name string, :Description string, :Type [:one-of ["CUSTOMER_MANAGED" "AWS_MANAGED"]], :CreatedTime timestamp, :Version integer, :Content {:InputSchema string, :Template string, :Actions [:seq-of string]}, :Status [:one-of ["PUBLISHED" "SAVED"]]}}}, :SearchHoursOfOperations {:documentation "Searches the hours of operation in an Amazon Connect instance, with optional filtering.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:TagFilter {:OrConditions [:seq-of [:seq-of {:TagKey string, :TagValue string}]], :AndConditions [:seq-of {:TagKey string, :TagValue string}], :TagCondition {:TagKey string, :TagValue string}}}, :SearchCriteria shape/HoursOfOperationSearchCriteria}, :required [:InstanceId], :response {:HoursOfOperations [:seq-of {:LastModifiedTime timestamp, :Config [:seq-of {:Day [:one-of ["SUNDAY" "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY"]], :StartTime {:Hours integer, :Minutes integer}, :EndTime {:Hours integer, :Minutes integer}}], :HoursOfOperationArn string, :Tags [:map-of string string], :TimeZone string, :LastModifiedRegion string, :Name string, :Description string, :HoursOfOperationId string}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/HoursOfOperationSearchCriteria {:OrConditions [:seq-of shape/HoursOfOperationSearchCriteria], :AndConditions [:seq-of shape/HoursOfOperationSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}}, :DeleteContactEvaluation {:documentation "Deletes a contact evaluation in the specified Amazon Connect instance.
", :request {:InstanceId string, :EvaluationId string}, :required [:InstanceId :EvaluationId]}, :DismissUserContact {:documentation "Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED
, ERROR
, ENDED
, or REJECTED
state in the Agent Event Stream.
", :request {:UserId string, :InstanceId string, :ContactId string}, :required [:UserId :InstanceId :ContactId]}, :SearchVocabularies {:documentation "Searches for vocabularies within a specific Amazon Connect instance using State
, NameStartsWith
, and LanguageCode
.
", :request {:InstanceId string, :MaxResults integer, :NextToken string, :State [:one-of ["CREATION_IN_PROGRESS" "ACTIVE" "CREATION_FAILED" "DELETE_IN_PROGRESS"]], :NameStartsWith string, :LanguageCode [:one-of ["ar-AE" "de-CH" "de-DE" "en-AB" "en-AU" "en-GB" "en-IE" "en-IN" "en-US" "en-WL" "es-ES" "es-US" "fr-CA" "fr-FR" "hi-IN" "it-IT" "ja-JP" "ko-KR" "pt-BR" "pt-PT" "zh-CN" "en-NZ" "en-ZA" "ca-ES" "da-DK" "fi-FI" "id-ID" "ms-MY" "nl-NL" "no-NO" "pl-PL" "sv-SE" "tl-PH"]]}, :required [:InstanceId], :response {:VocabularySummaryList [:seq-of {:Name string, :Id string, :Arn string, :LanguageCode [:one-of ["ar-AE" "de-CH" "de-DE" "en-AB" "en-AU" "en-GB" "en-IE" "en-IN" "en-US" "en-WL" "es-ES" "es-US" "fr-CA" "fr-FR" "hi-IN" "it-IT" "ja-JP" "ko-KR" "pt-BR" "pt-PT" "zh-CN" "en-NZ" "en-ZA" "ca-ES" "da-DK" "fi-FI" "id-ID" "ms-MY" "nl-NL" "no-NO" "pl-PL" "sv-SE" "tl-PH"]], :State [:one-of ["CREATION_IN_PROGRESS" "ACTIVE" "CREATION_FAILED" "DELETE_IN_PROGRESS"]], :LastModifiedTime timestamp, :FailureReason string}], :NextToken string}}, :TagResource {:documentation "Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
", :request {:resourceArn string, :tags [:map-of string string]}, :required [:resourceArn :tags]}, :ListInstances {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
", :request {:NextToken string, :MaxResults integer}, :response {:InstanceSummaryList [:seq-of {:OutboundCallsEnabled boolean, :Id string, :InstanceAlias string, :IdentityManagementType [:one-of ["SAML" "CONNECT_MANAGED" "EXISTING_DIRECTORY"]], :InstanceStatus [:one-of ["CREATION_IN_PROGRESS" "ACTIVE" "CREATION_FAILED"]], :ServiceRole string, :InstanceAccessUrl string, :Arn string, :CreatedTime timestamp, :InboundCallsEnabled boolean}], :NextToken string}}, :DescribePredefinedAttribute {:documentation "Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
", :request {:InstanceId string, :Name string}, :required [:InstanceId :Name], :response {:PredefinedAttribute {:Name string, :Values {:StringList [:seq-of string]}, :LastModifiedTime timestamp, :LastModifiedRegion string}}}, :BatchGetFlowAssociation {:documentation "Retrieve the flow associations for the given resources.
", :request {:InstanceId string, :ResourceIds [:seq-of string], :ResourceType [:one-of ["VOICE_PHONE_NUMBER"]]}, :required [:InstanceId :ResourceIds], :response {:FlowAssociationSummaryList [:seq-of {:ResourceId string, :FlowId string, :ResourceType [:one-of ["VOICE_PHONE_NUMBER"]]}]}}, :UpdateQueueMaxContacts {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
", :request {:InstanceId string, :QueueId string, :MaxContacts integer}, :required [:InstanceId :QueueId]}, :GetCurrentMetricData {:documentation "Gets 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 Administrator Guide.
", :request {:InstanceId string, :Filters {:Queues [:seq-of string], :Channels [:seq-of [:one-of ["VOICE" "CHAT" "TASK"]]], :RoutingProfiles [:seq-of string], :RoutingStepExpressions [:seq-of string]}, :Groupings [:seq-of [:one-of ["QUEUE" "CHANNEL" "ROUTING_PROFILE" "ROUTING_STEP_EXPRESSION"]]], :CurrentMetrics [:seq-of {:Name [:one-of ["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"]], :Unit [:one-of ["SECONDS" "COUNT" "PERCENT"]]}], :NextToken string, :MaxResults integer, :SortCriteria [:seq-of {:SortByMetric [:one-of ["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"]], :SortOrder [:one-of ["ASCENDING" "DESCENDING"]]}]}, :required [:InstanceId :Filters :CurrentMetrics], :response {:NextToken string, :MetricResults [:seq-of {:Dimensions {:Queue {:Id string, :Arn string}, :Channel [:one-of ["VOICE" "CHAT" "TASK"]], :RoutingProfile {:Id string, :Arn string}, :RoutingStepExpression string}, :Collections [:seq-of {:Metric {:Name [:one-of ["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"]], :Unit [:one-of ["SECONDS" "COUNT" "PERCENT"]]}, :Value double}]}], :DataSnapshotTime timestamp, :ApproximateTotalCount long}}, :DisassociateTrafficDistributionGroupUser {:documentation "Disassociates an agent from a traffic distribution group.
", :request {:TrafficDistributionGroupId string, :UserId string, :InstanceId string}, :required [:TrafficDistributionGroupId :UserId :InstanceId]}, :ReplicateInstance {:documentation "Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
", :request {:InstanceId string, :ReplicaRegion string, :ClientToken string, :ReplicaAlias string}, :required [:InstanceId :ReplicaRegion :ReplicaAlias], :response {:Id string, :Arn string}}, :DeleteVocabulary {:documentation "Deletes the vocabulary that has the given identifier.
", :request {:InstanceId string, :VocabularyId string}, :required [:InstanceId :VocabularyId], :response {:VocabularyArn string, :VocabularyId string, :State [:one-of ["CREATION_IN_PROGRESS" "ACTIVE" "CREATION_FAILED" "DELETE_IN_PROGRESS"]]}}, :UntagResource {:documentation "Removes the specified tags from the specified resource.
", :request {:resourceArn string, :tagKeys [:seq-of string]}, :required [:resourceArn :tagKeys]}, :DescribeQuickConnect {:documentation "Describes the quick connect.
", :request {:InstanceId string, :QuickConnectId string}, :required [:InstanceId :QuickConnectId], :response {:QuickConnect {:QuickConnectARN string, :QuickConnectId string, :Name string, :Description string, :QuickConnectConfig {:QuickConnectType [:one-of ["USER" "QUEUE" "PHONE_NUMBER"]], :UserConfig {:UserId string, :ContactFlowId string}, :QueueConfig {:QueueId string, :ContactFlowId string}, :PhoneConfig {:PhoneNumber string}}, :Tags [:map-of string string], :LastModifiedTime timestamp, :LastModifiedRegion string}}}, :DisassociateApprovedOrigin {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
", :request {:InstanceId string, :Origin string}, :required [:InstanceId :Origin]}, :UpdateRoutingProfileDefaultOutboundQueue {:documentation "Updates the default outbound queue of a routing profile.
", :request {:InstanceId string, :RoutingProfileId string, :DefaultOutboundQueueId string}, :required [:InstanceId :RoutingProfileId :DefaultOutboundQueueId]}, :CreateUseCase {:documentation "Creates a use case for an integration association.
", :request {:InstanceId string, :IntegrationAssociationId string, :UseCaseType [:one-of ["RULES_EVALUATION" "CONNECT_CAMPAIGNS"]], :Tags [:map-of string string]}, :required [:InstanceId :IntegrationAssociationId :UseCaseType], :response {:UseCaseId string, :UseCaseArn string}}, :UpdateEvaluationForm {:documentation "Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
", :request {:EvaluationFormId string, :Items [:seq-of shape/EvaluationFormItem], :InstanceId string, :Title string, :EvaluationFormVersion integer, :ScoringStrategy {:Mode [:one-of ["QUESTION_ONLY" "SECTION_ONLY"]], :Status [:one-of ["ENABLED" "DISABLED"]]}, :Description string, :ClientToken string, :CreateNewVersion boolean}, :required [:InstanceId :EvaluationFormId :EvaluationFormVersion :Title :Items], :response {:EvaluationFormId string, :EvaluationFormArn string, :EvaluationFormVersion integer}, :refs {shape/EvaluationFormItem {:Section {:Title string, :RefId string, :Instructions string, :Items [:seq-of shape/EvaluationFormItem], :Weight double}, :Question {:Title string, :Instructions string, :RefId string, :NotApplicableEnabled boolean, :QuestionType [:one-of ["TEXT" "SINGLESELECT" "NUMERIC"]], :QuestionTypeProperties {:Numeric {:MinValue integer, :MaxValue integer, :Options [:seq-of {:MinValue integer, :MaxValue integer, :Score integer, :AutomaticFail boolean}], :Automation {:PropertyValue {:Label [:one-of ["OVERALL_CUSTOMER_SENTIMENT_SCORE" "OVERALL_AGENT_SENTIMENT_SCORE" "NON_TALK_TIME" "NON_TALK_TIME_PERCENTAGE" "NUMBER_OF_INTERRUPTIONS" "CONTACT_DURATION" "AGENT_INTERACTION_DURATION" "CUSTOMER_HOLD_TIME"]]}}}, :SingleSelect {:Options [:seq-of {:RefId string, :Text string, :Score integer, :AutomaticFail boolean}], :DisplayAs [:one-of ["DROPDOWN" "RADIO"]], :Automation {:Options [:seq-of {:RuleCategory {:Category string, :Condition [:one-of ["PRESENT" "NOT_PRESENT"]], :OptionRefId string}}], :DefaultOptionRefId string}}}, :Weight double}}}}, :CreateAgentStatus {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
", :request {:InstanceId string, :Name string, :Description string, :State [:one-of ["ENABLED" "DISABLED"]], :DisplayOrder integer, :Tags [:map-of string string]}, :required [:InstanceId :Name :State], :response {:AgentStatusARN string, :AgentStatusId string}}, :DescribePrompt {:documentation "Describes the prompt.
", :request {:InstanceId string, :PromptId string}, :required [:InstanceId :PromptId], :response {:Prompt {:PromptARN string, :PromptId string, :Name string, :Description string, :Tags [:map-of string string], :LastModifiedTime timestamp, :LastModifiedRegion string}}}, :CreateTrafficDistributionGroup {:documentation "Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
", :request {:Name string, :Description string, :InstanceId string, :ClientToken string, :Tags [:map-of string string]}, :required [:Name :InstanceId], :response {:Id string, :Arn string}}, :ListRoutingProfiles {:documentation "Provides 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 the Amazon Connect Administrator Guide.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:RoutingProfileSummaryList [:seq-of {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string}}, :UpdateInstanceAttribute {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
", :request {:InstanceId string, :AttributeType [:one-of ["INBOUND_CALLS" "OUTBOUND_CALLS" "CONTACTFLOW_LOGS" "CONTACT_LENS" "AUTO_RESOLVE_BEST_VOICES" "USE_CUSTOM_TTS_VOICES" "EARLY_MEDIA" "MULTI_PARTY_CONFERENCE" "HIGH_VOLUME_OUTBOUND" "ENHANCED_CONTACT_MONITORING" "ENHANCED_CHAT_MONITORING"]], :Value string}, :required [:InstanceId :AttributeType :Value]}, :DisassociateLexBot {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
", :request {:InstanceId string, :BotName string, :LexRegion string}, :required [:InstanceId :BotName :LexRegion]}, :ListUserHierarchyGroups {:documentation "Provides 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 Connect Administrator Guide.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:UserHierarchyGroupSummaryList [:seq-of {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string}}, :UpdateTaskTemplate {:documentation "Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
", :request {:InstanceId string, :ContactFlowId string, :TaskTemplateId string, :Constraints {:RequiredFields [:seq-of {:Id {:Name string}}], :ReadOnlyFields [:seq-of {:Id {:Name string}}], :InvisibleFields [:seq-of {:Id {:Name string}}]}, :Defaults {:DefaultFieldValues [:seq-of {:Id {:Name string}, :DefaultValue string}]}, :Name string, :Description string, :Fields [:seq-of {:Id {:Name string}, :Description string, :Type [:one-of ["NAME" "DESCRIPTION" "SCHEDULED_TIME" "QUICK_CONNECT" "URL" "NUMBER" "TEXT" "TEXT_AREA" "DATE_TIME" "BOOLEAN" "SINGLE_SELECT" "EMAIL"]], :SingleSelectOptions [:seq-of string]}], :Status [:one-of ["ACTIVE" "INACTIVE"]]}, :required [:TaskTemplateId :InstanceId], :response {:LastModifiedTime timestamp, :Id string, :InstanceId string, :ContactFlowId string, :Constraints {:RequiredFields [:seq-of {:Id {:Name string}}], :ReadOnlyFields [:seq-of {:Id {:Name string}}], :InvisibleFields [:seq-of {:Id {:Name string}}]}, :Arn string, :Defaults {:DefaultFieldValues [:seq-of {:Id {:Name string}, :DefaultValue string}]}, :Name string, :Description string, :CreatedTime timestamp, :Fields [:seq-of {:Id {:Name string}, :Description string, :Type [:one-of ["NAME" "DESCRIPTION" "SCHEDULED_TIME" "QUICK_CONNECT" "URL" "NUMBER" "TEXT" "TEXT_AREA" "DATE_TIME" "BOOLEAN" "SINGLE_SELECT" "EMAIL"]], :SingleSelectOptions [:seq-of string]}], :Status [:one-of ["ACTIVE" "INACTIVE"]]}}, :UpdateAgentStatus {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
", :request {:InstanceId string, :AgentStatusId string, :Name string, :Description string, :State [:one-of ["ENABLED" "DISABLED"]], :DisplayOrder integer, :ResetOrderNumber boolean}, :required [:InstanceId :AgentStatusId]}, :UpdatePredefinedAttribute {:documentation "Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
", :request {:InstanceId string, :Name string, :Values {:StringList [:seq-of string]}}, :required [:InstanceId :Name]}, :SearchAvailablePhoneNumbers {:documentation "Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
", :request {:TargetArn string, :InstanceId string, :PhoneNumberCountryCode [:one-of ["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"]], :PhoneNumberType [:one-of ["TOLL_FREE" "DID" "UIFN" "SHARED" "THIRD_PARTY_TF" "THIRD_PARTY_DID" "SHORT_CODE"]], :PhoneNumberPrefix string, :MaxResults integer, :NextToken string}, :required [:PhoneNumberCountryCode :PhoneNumberType], :response {:NextToken string, :AvailableNumbersList [:seq-of {:PhoneNumber string, :PhoneNumberCountryCode [:one-of ["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"]], :PhoneNumberType [:one-of ["TOLL_FREE" "DID" "UIFN" "SHARED" "THIRD_PARTY_TF" "THIRD_PARTY_DID" "SHORT_CODE"]]}]}}, :DeleteSecurityProfile {:documentation "Deletes a security profile.
", :request {:InstanceId string, :SecurityProfileId string}, :required [:InstanceId :SecurityProfileId]}, :BatchGetAttachedFileMetadata {:documentation "Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
", :request {:FileIds [:seq-of string], :InstanceId string, :AssociatedResourceArn string}, :required [:FileIds :InstanceId :AssociatedResourceArn], :response {:Files [:seq-of {:FileArn string, :FileSizeInBytes long, :Tags [:map-of string string], :CreatedBy {:ConnectUserArn string, :AWSIdentityArn string}, :FileStatus [:one-of ["APPROVED" "REJECTED" "PROCESSING" "FAILED"]], :FileId string, :CreationTime string, :AssociatedResourceArn string, :FileUseCaseType [:one-of ["ATTACHMENT"]], :FileName string}], :Errors [:seq-of {:ErrorCode string, :ErrorMessage string, :FileId string}]}}, :BatchDisassociateAnalyticsDataSet {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
", :request {:InstanceId string, :DataSetIds [:seq-of string], :TargetAccountId string}, :required [:InstanceId :DataSetIds], :response {:Deleted [:seq-of string], :Errors [:seq-of {:ErrorCode string, :ErrorMessage string}]}}, :DescribeVocabulary {:documentation "Describes the specified vocabulary.
", :request {:InstanceId string, :VocabularyId string}, :required [:InstanceId :VocabularyId], :response {:Vocabulary {:LastModifiedTime timestamp, :Id string, :Tags [:map-of string string], :Arn string, :Name string, :State [:one-of ["CREATION_IN_PROGRESS" "ACTIVE" "CREATION_FAILED" "DELETE_IN_PROGRESS"]], :FailureReason string, :Content string, :LanguageCode [:one-of ["ar-AE" "de-CH" "de-DE" "en-AB" "en-AU" "en-GB" "en-IE" "en-IN" "en-US" "en-WL" "es-ES" "es-US" "fr-CA" "fr-FR" "hi-IN" "it-IT" "ja-JP" "ko-KR" "pt-BR" "pt-PT" "zh-CN" "en-NZ" "en-ZA" "ca-ES" "da-DK" "fi-FI" "id-ID" "ms-MY" "nl-NL" "no-NO" "pl-PL" "sv-SE" "tl-PH"]]}}}, :UpdateHoursOfOperation {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
", :request {:InstanceId string, :HoursOfOperationId string, :Name string, :Description string, :TimeZone string, :Config [:seq-of {:Day [:one-of ["SUNDAY" "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY"]], :StartTime {:Hours integer, :Minutes integer}, :EndTime {:Hours integer, :Minutes integer}}]}, :required [:InstanceId :HoursOfOperationId]}, :CreateContactFlow {:documentation "Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
", :request {:InstanceId string, :Name string, :Type [:one-of ["CONTACT_FLOW" "CUSTOMER_QUEUE" "CUSTOMER_HOLD" "CUSTOMER_WHISPER" "AGENT_HOLD" "AGENT_WHISPER" "OUTBOUND_WHISPER" "AGENT_TRANSFER" "QUEUE_TRANSFER"]], :Description string, :Content string, :Status [:one-of ["PUBLISHED" "SAVED"]], :Tags [:map-of string string]}, :required [:InstanceId :Name :Type :Content], :response {:ContactFlowId string, :ContactFlowArn string}}, :UpdateAuthenticationProfile {:documentation "This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
", :request {:AuthenticationProfileId string, :InstanceId string, :Name string, :Description string, :AllowedIps [:seq-of string], :BlockedIps [:seq-of string], :PeriodicSessionDuration integer}, :required [:AuthenticationProfileId :InstanceId]}, :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, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelTwo {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelThree {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelFour {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelFive {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}}}}, :ListContactReferences {:documentation "This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes
, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.
", :request {:InstanceId string, :ContactId string, :ReferenceTypes [:seq-of [:one-of ["URL" "ATTACHMENT" "NUMBER" "STRING" "DATE" "EMAIL"]]], :NextToken string}, :required [:InstanceId :ContactId :ReferenceTypes], :response {:ReferenceSummaryList [:seq-of {:Url {:Name string, :Value string}, :Attachment {:Name string, :Value string, :Status [:one-of ["APPROVED" "REJECTED"]]}, :String {:Name string, :Value string}, :Number {:Name string, :Value string}, :Date {:Name string, :Value string}, :Email {:Name string, :Value string}}], :NextToken string}}, :UpdateContactEvaluation {:documentation "Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}
) to the question identifier.
", :request {:InstanceId string, :EvaluationId string, :Answers [:map-of string {:Value {:StringValue string, :NumericValue double, :NotApplicable boolean}}], :Notes [:map-of string {:Value string}]}, :required [:InstanceId :EvaluationId], :response {:EvaluationId string, :EvaluationArn string}}, :ListAnalyticsDataAssociations {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
", :request {:InstanceId string, :DataSetId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:Results [:seq-of {:DataSetId string, :TargetAccountId string, :ResourceShareId string, :ResourceShareArn string}], :NextToken string}}, :ListPredefinedAttributes {:documentation "Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:NextToken string, :PredefinedAttributeSummaryList [:seq-of {:Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}]}}, :UntagContact {:documentation "Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
", :request {:ContactId string, :InstanceId string, :TagKeys [:seq-of string]}, :required [:ContactId :InstanceId :TagKeys]}, :ListHoursOfOperations {:documentation "Provides 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 the Amazon Connect Administrator Guide.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:HoursOfOperationSummaryList [:seq-of {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string}}, :UpdateContactFlowModuleContent {:documentation "Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
", :request {:InstanceId string, :ContactFlowModuleId string, :Content string}, :required [:InstanceId :ContactFlowModuleId :Content]}, :GetAttachedFile {:documentation "Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED
.
", :request {:InstanceId string, :FileId string, :UrlExpiryInSeconds integer, :AssociatedResourceArn string}, :required [:InstanceId :FileId :AssociatedResourceArn], :response {:FileArn string, :FileSizeInBytes long, :Tags [:map-of string string], :CreatedBy {:ConnectUserArn string, :AWSIdentityArn string}, :FileStatus [:one-of ["APPROVED" "REJECTED" "PROCESSING" "FAILED"]], :FileId string, :DownloadUrlMetadata {:Url string, :UrlExpiry string}, :CreationTime string, :AssociatedResourceArn string, :FileUseCaseType [:one-of ["ATTACHMENT"]], :FileName string}}, :AssociateInstanceStorageConfig {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
", :request {:InstanceId string, :ResourceType [:one-of ["CHAT_TRANSCRIPTS" "CALL_RECORDINGS" "SCHEDULED_REPORTS" "MEDIA_STREAMS" "CONTACT_TRACE_RECORDS" "AGENT_EVENTS" "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" "ATTACHMENTS" "CONTACT_EVALUATIONS" "SCREEN_RECORDINGS" "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS" "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS"]], :StorageConfig {:AssociationId string, :StorageType [:one-of ["S3" "KINESIS_VIDEO_STREAM" "KINESIS_STREAM" "KINESIS_FIREHOSE"]], :S3Config {:BucketName string, :BucketPrefix string, :EncryptionConfig {:EncryptionType [:one-of ["KMS"]], :KeyId string}}, :KinesisVideoStreamConfig {:Prefix string, :RetentionPeriodHours integer, :EncryptionConfig {:EncryptionType [:one-of ["KMS"]], :KeyId string}}, :KinesisStreamConfig {:StreamArn string}, :KinesisFirehoseConfig {:FirehoseArn string}}}, :required [:InstanceId :ResourceType :StorageConfig], :response {:AssociationId string}}, :ListRoutingProfileQueues {:documentation "Lists the queues associated with a routing profile.
", :request {:InstanceId string, :RoutingProfileId string, :NextToken string, :MaxResults integer}, :required [:InstanceId :RoutingProfileId], :response {:NextToken string, :RoutingProfileQueueConfigSummaryList [:seq-of {:QueueId string, :QueueArn string, :QueueName string, :Priority integer, :Delay integer, :Channel [:one-of ["VOICE" "CHAT" "TASK"]]}], :LastModifiedTime timestamp, :LastModifiedRegion string}}, :UpdateRoutingProfileConcurrency {:documentation "Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
", :request {:InstanceId string, :RoutingProfileId string, :MediaConcurrencies [:seq-of {:Channel [:one-of ["VOICE" "CHAT" "TASK"]], :Concurrency integer, :CrossChannelBehavior {:BehaviorType [:one-of ["ROUTE_CURRENT_CHANNEL_ONLY" "ROUTE_ANY_CHANNEL"]]}}]}, :required [:InstanceId :RoutingProfileId :MediaConcurrencies]}, :DeleteViewVersion {:documentation "Deletes the particular version specified in ViewVersion
identifier.
", :request {:InstanceId string, :ViewId string, :ViewVersion integer}, :required [:InstanceId :ViewId :ViewVersion]}, :ListRules {:documentation "List all rules for the specified Amazon Connect instance.
", :request {:InstanceId string, :PublishStatus [:one-of ["DRAFT" "PUBLISHED"]], :EventSourceName [:one-of ["OnPostCallAnalysisAvailable" "OnRealTimeCallAnalysisAvailable" "OnRealTimeChatAnalysisAvailable" "OnPostChatAnalysisAvailable" "OnZendeskTicketCreate" "OnZendeskTicketStatusUpdate" "OnSalesforceCaseCreate" "OnContactEvaluationSubmit" "OnMetricDataUpdate" "OnCaseCreate" "OnCaseUpdate"]], :MaxResults integer, :NextToken string}, :required [:InstanceId], :response {:RuleSummaryList [:seq-of {:Name string, :RuleId string, :RuleArn string, :EventSourceName [:one-of ["OnPostCallAnalysisAvailable" "OnRealTimeCallAnalysisAvailable" "OnRealTimeChatAnalysisAvailable" "OnPostChatAnalysisAvailable" "OnZendeskTicketCreate" "OnZendeskTicketStatusUpdate" "OnSalesforceCaseCreate" "OnContactEvaluationSubmit" "OnMetricDataUpdate" "OnCaseCreate" "OnCaseUpdate"]], :PublishStatus [:one-of ["DRAFT" "PUBLISHED"]], :ActionSummaries [:seq-of {:ActionType [:one-of ["CREATE_TASK" "ASSIGN_CONTACT_CATEGORY" "GENERATE_EVENTBRIDGE_EVENT" "SEND_NOTIFICATION" "CREATE_CASE" "UPDATE_CASE" "END_ASSOCIATED_TASKS" "SUBMIT_AUTO_EVALUATION"]]}], :CreatedTime timestamp, :LastUpdatedTime timestamp}], :NextToken string}}, :StartOutboundVoiceContact {:documentation "Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId
).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the 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, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType
= CAMPAIGN
, you must submit a service quota increase request to the quota Amazon Connect campaigns.
", :request {:References [:map-of string {:Value string, :Type [:one-of ["URL" "ATTACHMENT" "NUMBER" "STRING" "DATE" "EMAIL"]]}], :AnswerMachineDetectionConfig {:EnableAnswerMachineDetection boolean, :AwaitAnswerMachinePrompt boolean}, :QueueId string, :InstanceId string, :ContactFlowId string, :DestinationPhoneNumber string, :SourcePhoneNumber string, :TrafficType [:one-of ["GENERAL" "CAMPAIGN"]], :RelatedContactId string, :Name string, :Description string, :ClientToken string, :Attributes [:map-of string string], :CampaignId string}, :required [:DestinationPhoneNumber :ContactFlowId :InstanceId], :response {:ContactId string}}, :ListQueues {:documentation "Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes
parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
", :request {:InstanceId string, :QueueTypes [:seq-of [:one-of ["STANDARD" "AGENT"]]], :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:QueueSummaryList [:seq-of {:Id string, :Arn string, :Name string, :QueueType [:one-of ["STANDARD" "AGENT"]], :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string}}, :DisassociateFlow {:documentation "Disassociates a connect resource from a flow.
", :request {:InstanceId string, :ResourceId string, :ResourceType [:one-of ["SMS_PHONE_NUMBER"]]}, :required [:InstanceId :ResourceId :ResourceType]}, :AssociateDefaultVocabulary {:documentation "Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
", :request {:InstanceId string, :LanguageCode [:one-of ["ar-AE" "de-CH" "de-DE" "en-AB" "en-AU" "en-GB" "en-IE" "en-IN" "en-US" "en-WL" "es-ES" "es-US" "fr-CA" "fr-FR" "hi-IN" "it-IT" "ja-JP" "ko-KR" "pt-BR" "pt-PT" "zh-CN" "en-NZ" "en-ZA" "ca-ES" "da-DK" "fi-FI" "id-ID" "ms-MY" "nl-NL" "no-NO" "pl-PL" "sv-SE" "tl-PH"]], :VocabularyId string}, :required [:InstanceId :LanguageCode]}, :DisassociateUserProficiencies {:documentation "Disassociates a set of proficiencies from a user.
", :request {:InstanceId string, :UserId string, :UserProficiencies [:seq-of {:AttributeName string, :AttributeValue string}]}, :required [:InstanceId :UserId :UserProficiencies]}, :UpdateUserSecurityProfiles {:documentation "Assigns the specified security profiles to the specified user.
", :request {:SecurityProfileIds [:seq-of string], :UserId string, :InstanceId string}, :required [:SecurityProfileIds :UserId :InstanceId]}, :StopContactRecording {:documentation "Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
", :request {:InstanceId string, :ContactId string, :InitialContactId string}, :required [:InstanceId :ContactId :InitialContactId]}, :SearchContactFlowModules {:documentation "Searches the flow modules in an Amazon Connect instance, with optional filtering.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:TagFilter {:OrConditions [:seq-of [:seq-of {:TagKey string, :TagValue string}]], :AndConditions [:seq-of {:TagKey string, :TagValue string}], :TagCondition {:TagKey string, :TagValue string}}}, :SearchCriteria shape/ContactFlowModuleSearchCriteria}, :required [:InstanceId], :response {:ContactFlowModules [:seq-of {:Arn string, :Id string, :Name string, :Content string, :Description string, :State [:one-of ["ACTIVE" "ARCHIVED"]], :Status [:one-of ["PUBLISHED" "SAVED"]], :Tags [:map-of string string]}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/ContactFlowModuleSearchCriteria {:OrConditions [:seq-of shape/ContactFlowModuleSearchCriteria], :AndConditions [:seq-of shape/ContactFlowModuleSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}}, :GetMetricDataV2 {:documentation "Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2
offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2
and GetMetricData
, see Historical metrics definitions in the Amazon Connect Administrator Guide.
", :request {:EndTime timestamp, :Groupings [:seq-of string], :NextToken string, :Metrics [:seq-of {:Name string, :Threshold [:seq-of {:Comparison string, :ThresholdValue double}], :MetricFilters [:seq-of {:MetricFilterKey string, :MetricFilterValues [:seq-of string], :Negate boolean}]}], :Interval {:TimeZone string, :IntervalPeriod [:one-of ["FIFTEEN_MIN" "THIRTY_MIN" "HOUR" "DAY" "WEEK" "TOTAL"]]}, :StartTime timestamp, :MaxResults integer, :ResourceArn string, :Filters [:seq-of {:FilterKey string, :FilterValues [:seq-of string]}]}, :required [:ResourceArn :StartTime :EndTime :Filters :Metrics], :response {:NextToken string, :MetricResults [:seq-of {:Dimensions [:map-of string string], :MetricInterval {:Interval [:one-of ["FIFTEEN_MIN" "THIRTY_MIN" "HOUR" "DAY" "WEEK" "TOTAL"]], :StartTime timestamp, :EndTime timestamp}, :Collections [:seq-of {:Metric {:Name string, :Threshold [:seq-of {:Comparison string, :ThresholdValue double}], :MetricFilters [:seq-of {:MetricFilterKey string, :MetricFilterValues [:seq-of string], :Negate boolean}]}, :Value double}]}]}}, :DisassociateBot {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
", :request {:InstanceId string, :LexBot {:Name string, :LexRegion string}, :LexV2Bot {:AliasArn string}}, :required [:InstanceId]}, :ListAgentStatuses {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :AgentStatusTypes [:seq-of [:one-of ["ROUTABLE" "CUSTOM" "OFFLINE"]]]}, :required [:InstanceId], :response {:NextToken string, :AgentStatusSummaryList [:seq-of {:Id string, :Arn string, :Name string, :Type [:one-of ["ROUTABLE" "CUSTOM" "OFFLINE"]], :LastModifiedTime timestamp, :LastModifiedRegion string}]}}, :CompleteAttachedFileUpload {:documentation "Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
", :request {:InstanceId string, :FileId string, :AssociatedResourceArn string}, :required [:InstanceId :FileId :AssociatedResourceArn]}, :DisassociateSecurityKey {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
", :request {:InstanceId string, :AssociationId string}, :required [:InstanceId :AssociationId]}, :GetPromptFile {:documentation "Gets the prompt file.
", :request {:InstanceId string, :PromptId string}, :required [:InstanceId :PromptId], :response {:PromptPresignedUrl string, :LastModifiedTime timestamp, :LastModifiedRegion string}}, :UpdateUserRoutingProfile {:documentation "Assigns the specified routing profile to the specified user.
", :request {:RoutingProfileId string, :UserId string, :InstanceId string}, :required [:RoutingProfileId :UserId :InstanceId]}, :ListQuickConnects {:documentation "Provides information about the quick connects for the specified Amazon Connect instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :QuickConnectTypes [:seq-of [:one-of ["USER" "QUEUE" "PHONE_NUMBER"]]]}, :required [:InstanceId], :response {:QuickConnectSummaryList [:seq-of {:Id string, :Arn string, :Name string, :QuickConnectType [:one-of ["USER" "QUEUE" "PHONE_NUMBER"]], :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string}}, :UpdateQueueStatus {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
", :request {:InstanceId string, :QueueId string, :Status [:one-of ["ENABLED" "DISABLED"]]}, :required [:InstanceId :QueueId :Status]}, :StartAttachedFileUpload {:documentation "Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case.
", :request {:UrlExpiryInSeconds integer, :FileSizeInBytes long, :Tags [:map-of string string], :InstanceId string, :CreatedBy {:ConnectUserArn string, :AWSIdentityArn string}, :AssociatedResourceArn string, :ClientToken string, :FileUseCaseType [:one-of ["ATTACHMENT"]], :FileName string}, :required [:InstanceId :FileName :FileSizeInBytes :FileUseCaseType :AssociatedResourceArn], :response {:FileArn string, :FileId string, :CreationTime string, :FileStatus [:one-of ["APPROVED" "REJECTED" "PROCESSING" "FAILED"]], :CreatedBy {:ConnectUserArn string, :AWSIdentityArn string}, :UploadUrlMetadata {:Url string, :UrlExpiry string, :HeadersToInclude [:map-of string string]}}}, :UpdateUserHierarchyGroupName {:documentation "Updates the name of the user hierarchy group.
", :request {:Name string, :HierarchyGroupId string, :InstanceId string}, :required [:Name :HierarchyGroupId :InstanceId]}, :ListLambdaFunctions {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:LambdaFunctions [:seq-of string], :NextToken string}}, :ListUseCases {:documentation "Lists the use cases for the integration association.
", :request {:InstanceId string, :IntegrationAssociationId string, :NextToken string, :MaxResults integer}, :required [:InstanceId :IntegrationAssociationId], :response {:UseCaseSummaryList [:seq-of {:UseCaseId string, :UseCaseArn string, :UseCaseType [:one-of ["RULES_EVALUATION" "CONNECT_CAMPAIGNS"]]}], :NextToken string}}, :DeleteInstance {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
", :request {:InstanceId string}, :required [:InstanceId]}, :ListContactFlowModules {:documentation "Provides information about the flow modules for the specified Amazon Connect instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :ContactFlowModuleState [:one-of ["ACTIVE" "ARCHIVED"]]}, :required [:InstanceId], :response {:ContactFlowModulesSummaryList [:seq-of {:Id string, :Arn string, :Name string, :State [:one-of ["ACTIVE" "ARCHIVED"]]}], :NextToken string}}, :DescribeContactEvaluation {:documentation "Describes a contact evaluation in the specified Amazon Connect instance.
", :request {:InstanceId string, :EvaluationId string}, :required [:InstanceId :EvaluationId], :response {:Evaluation {:LastModifiedTime timestamp, :Tags [:map-of string string], :Answers [:map-of string {:Value {:StringValue string, :NumericValue double, :NotApplicable boolean}, :SystemSuggestedValue {:StringValue string, :NumericValue double, :NotApplicable boolean}}], :Metadata {:ContactId string, :EvaluatorArn string, :ContactAgentId string, :Score {:Percentage double, :NotApplicable boolean, :AutomaticFail boolean}}, :EvaluationArn string, :Notes [:map-of string {:Value string}], :Scores [:map-of string {:Percentage double, :NotApplicable boolean, :AutomaticFail boolean}], :CreatedTime timestamp, :EvaluationId string, :Status [:one-of ["DRAFT" "SUBMITTED"]]}, :EvaluationForm {:EvaluationFormVersion integer, :EvaluationFormId string, :EvaluationFormArn string, :Title string, :Description string, :Items [:seq-of shape/EvaluationFormItem], :ScoringStrategy {:Mode [:one-of ["QUESTION_ONLY" "SECTION_ONLY"]], :Status [:one-of ["ENABLED" "DISABLED"]]}}}, :refs {shape/EvaluationFormItem {:Section {:Title string, :RefId string, :Instructions string, :Items [:seq-of shape/EvaluationFormItem], :Weight double}, :Question {:Title string, :Instructions string, :RefId string, :NotApplicableEnabled boolean, :QuestionType [:one-of ["TEXT" "SINGLESELECT" "NUMERIC"]], :QuestionTypeProperties {:Numeric {:MinValue integer, :MaxValue integer, :Options [:seq-of {:MinValue integer, :MaxValue integer, :Score integer, :AutomaticFail boolean}], :Automation {:PropertyValue {:Label [:one-of ["OVERALL_CUSTOMER_SENTIMENT_SCORE" "OVERALL_AGENT_SENTIMENT_SCORE" "NON_TALK_TIME" "NON_TALK_TIME_PERCENTAGE" "NUMBER_OF_INTERRUPTIONS" "CONTACT_DURATION" "AGENT_INTERACTION_DURATION" "CUSTOMER_HOLD_TIME"]]}}}, :SingleSelect {:Options [:seq-of {:RefId string, :Text string, :Score integer, :AutomaticFail boolean}], :DisplayAs [:one-of ["DROPDOWN" "RADIO"]], :Automation {:Options [:seq-of {:RuleCategory {:Category string, :Condition [:one-of ["PRESENT" "NOT_PRESENT"]], :OptionRefId string}}], :DefaultOptionRefId string}}}, :Weight double}}}}, :UpdateContactAttributes {:documentation "Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display 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 to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
", :request {:InitialContactId string, :InstanceId string, :Attributes [:map-of string string]}, :required [:InitialContactId :InstanceId :Attributes]}, :StopContact {:documentation "Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
-
DISCONNECT
-
TRANSFER
-
QUEUE_TRANSFER
-
EXTERNAL_OUTBOUND
-
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
", :request {:ContactId string, :InstanceId string, :DisconnectReason {:Code string}}, :required [:ContactId :InstanceId]}, :ListRealtimeContactAnalysisSegmentsV2 {:documentation "Provides a list of analysis segments for a real-time analysis session.
", :request {:InstanceId string, :ContactId string, :MaxResults integer, :NextToken string, :OutputType [:one-of ["Raw" "Redacted"]], :SegmentTypes [:seq-of [:one-of ["Transcript" "Categories" "Issues" "Event" "Attachments" "PostContactSummary"]]]}, :required [:InstanceId :ContactId :OutputType :SegmentTypes], :response {:Channel [:one-of ["VOICE" "CHAT"]], :Status [:one-of ["IN_PROGRESS" "FAILED" "COMPLETED"]], :Segments [:seq-of {:Transcript {:Redaction {:CharacterOffsets [:seq-of {:BeginOffsetChar integer, :EndOffsetChar integer}]}, :Id string, :ParticipantId string, :DisplayName string, :Sentiment [:one-of ["POSITIVE" "NEGATIVE" "NEUTRAL"]], :Time {:AbsoluteTime timestamp}, :ContentType string, :Content string, :ParticipantRole [:one-of ["AGENT" "CUSTOMER" "SYSTEM" "CUSTOM_BOT" "SUPERVISOR"]]}, :Categories {:MatchedDetails [:map-of string {:PointsOfInterest [:seq-of {:TranscriptItems [:seq-of {:Id string, :CharacterOffsets {:BeginOffsetChar integer, :EndOffsetChar integer}}]}]}]}, :Issues {:IssuesDetected [:seq-of {:TranscriptItems [:seq-of {:Content string, :Id string, :CharacterOffsets {:BeginOffsetChar integer, :EndOffsetChar integer}}]}]}, :Event {:Id string, :ParticipantId string, :ParticipantRole [:one-of ["AGENT" "CUSTOMER" "SYSTEM" "CUSTOM_BOT" "SUPERVISOR"]], :DisplayName string, :EventType string, :Time {:AbsoluteTime timestamp}}, :Attachments {:Id string, :ParticipantId string, :ParticipantRole [:one-of ["AGENT" "CUSTOMER" "SYSTEM" "CUSTOM_BOT" "SUPERVISOR"]], :DisplayName string, :Attachments [:seq-of {:AttachmentName string, :ContentType string, :AttachmentId string, :Status [:one-of ["APPROVED" "REJECTED" "IN_PROGRESS"]]}], :Time {:AbsoluteTime timestamp}}, :PostContactSummary {:Content string, :Status [:one-of ["FAILED" "COMPLETED"]], :FailureCode [:one-of ["QUOTA_EXCEEDED" "INSUFFICIENT_CONVERSATION_CONTENT" "FAILED_SAFETY_GUIDELINES" "INVALID_ANALYSIS_CONFIGURATION" "INTERNAL_ERROR"]]}}], :NextToken string}}, :AssociateUserProficiencies {:documentation ">Associates a set of proficiencies with a user.
", :request {:InstanceId string, :UserId string, :UserProficiencies [:seq-of {:AttributeName string, :AttributeValue string, :Level float}]}, :required [:InstanceId :UserId :UserProficiencies]}, :SearchAgentStatuses {:documentation "Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:AttributeFilter {:OrConditions [:seq-of {:TagConditions [:seq-of {:TagKey string, :TagValue string}]}], :AndCondition {:TagConditions [:seq-of {:TagKey string, :TagValue string}]}, :TagCondition {:TagKey string, :TagValue string}}}, :SearchCriteria shape/AgentStatusSearchCriteria}, :required [:InstanceId], :response {:AgentStatuses [:seq-of {:LastModifiedTime timestamp, :DisplayOrder integer, :Tags [:map-of string string], :AgentStatusARN string, :LastModifiedRegion string, :Name string, :Description string, :AgentStatusId string, :Type [:one-of ["ROUTABLE" "CUSTOM" "OFFLINE"]], :State [:one-of ["ENABLED" "DISABLED"]]}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/AgentStatusSearchCriteria {:OrConditions [:seq-of shape/AgentStatusSearchCriteria], :AndConditions [:seq-of shape/AgentStatusSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}}, :DescribePhoneNumber {:documentation "Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
", :request {:PhoneNumberId string}, :required [:PhoneNumberId], :response {:ClaimedPhoneNumberSummary {:PhoneNumberId string, :PhoneNumberArn string, :PhoneNumberType [:one-of ["TOLL_FREE" "DID" "UIFN" "SHARED" "THIRD_PARTY_TF" "THIRD_PARTY_DID" "SHORT_CODE"]], :Tags [:map-of string string], :InstanceId string, :SourcePhoneNumberArn string, :PhoneNumberStatus {:Status [:one-of ["CLAIMED" "IN_PROGRESS" "FAILED"]], :Message string}, :PhoneNumberCountryCode [:one-of ["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"]], :PhoneNumber string, :PhoneNumberDescription string, :TargetArn string}}}, :GetContactAttributes {:documentation "Retrieves the contact attributes for the specified contact.
", :request {:InstanceId string, :InitialContactId string}, :required [:InstanceId :InitialContactId], :response {:Attributes [:map-of string string]}}, :StartTaskContact {:documentation "Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId
and RelatedContactId
input parameters, note the following:
-
PreviousContactId
-
Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId
will affect every contact in the chain.
-
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId
.
-
RelatedContactId
-
Copies contact attributes from the related task contact to the new contact.
-
Any update on attributes in a new task contact does not update attributes on previous contact.
-
There’s no limit on the number of task contacts that can be created that use the same RelatedContactId
.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID
, QuickConnectID
, or TaskTemplateID
. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID
is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException
occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId
. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.
", :request {:References [:map-of string {:Value string, :Type [:one-of ["URL" "ATTACHMENT" "NUMBER" "STRING" "DATE" "EMAIL"]]}], :QuickConnectId string, :PreviousContactId string, :ScheduledTime timestamp, :InstanceId string, :ContactFlowId string, :TaskTemplateId string, :RelatedContactId string, :Name string, :Description string, :ClientToken string, :Attributes [:map-of string string]}, :required [:InstanceId :Name], :response {:ContactId string}}, :ListLexBots {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:LexBots [:seq-of {:Name string, :LexRegion string}], :NextToken string}}, :SearchSecurityProfiles {:documentation "Searches security profiles in an Amazon Connect instance, with optional filtering.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchCriteria shape/SecurityProfileSearchCriteria, :SearchFilter {:TagFilter {:OrConditions [:seq-of [:seq-of {:TagKey string, :TagValue string}]], :AndConditions [:seq-of {:TagKey string, :TagValue string}], :TagCondition {:TagKey string, :TagValue string}}}}, :required [:InstanceId], :response {:SecurityProfiles [:seq-of {:Id string, :OrganizationResourceId string, :Arn string, :SecurityProfileName string, :Description string, :Tags [:map-of string string]}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/SecurityProfileSearchCriteria {:OrConditions [:seq-of shape/SecurityProfileSearchCriteria], :AndConditions [:seq-of shape/SecurityProfileSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}}, :UpdateUserPhoneConfig {:documentation "Updates the phone configuration settings for the specified user.
", :request {:PhoneConfig {:PhoneType [:one-of ["SOFT_PHONE" "DESK_PHONE"]], :AutoAccept boolean, :AfterContactWorkTimeLimit integer, :DeskPhoneNumber string}, :UserId string, :InstanceId string}, :required [:PhoneConfig :UserId :InstanceId]}, :SearchUsers {:documentation "Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:TagFilter {:OrConditions [:seq-of [:seq-of {:TagKey string, :TagValue string}]], :AndConditions [:seq-of {:TagKey string, :TagValue string}], :TagCondition {:TagKey string, :TagValue string}}, :UserAttributeFilter {:OrConditions [:seq-of {:TagConditions [:seq-of {:TagKey string, :TagValue string}], :HierarchyGroupCondition {:Value string, :HierarchyGroupMatchType [:one-of ["EXACT" "WITH_CHILD_GROUPS"]]}}], :AndCondition {:TagConditions [:seq-of {:TagKey string, :TagValue string}], :HierarchyGroupCondition {:Value string, :HierarchyGroupMatchType [:one-of ["EXACT" "WITH_CHILD_GROUPS"]]}}, :TagCondition {:TagKey string, :TagValue string}, :HierarchyGroupCondition {:Value string, :HierarchyGroupMatchType [:one-of ["EXACT" "WITH_CHILD_GROUPS"]]}}}, :SearchCriteria shape/UserSearchCriteria}, :required [:InstanceId], :response {:Users [:seq-of {:IdentityInfo {:FirstName string, :LastName string}, :SecurityProfileIds [:seq-of string], :Id string, :Tags [:map-of string string], :DirectoryUserId string, :RoutingProfileId string, :Arn string, :PhoneConfig {:PhoneType [:one-of ["SOFT_PHONE" "DESK_PHONE"]], :AutoAccept boolean, :AfterContactWorkTimeLimit integer, :DeskPhoneNumber string}, :Username string, :HierarchyGroupId string}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/UserSearchCriteria {:OrConditions [:seq-of shape/UserSearchCriteria], :AndConditions [:seq-of shape/UserSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}, :ListCondition {:TargetListType [:one-of ["PROFICIENCIES"]], :Conditions [:seq-of {:StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}, :NumberCondition {:FieldName string, :MinValue integer, :MaxValue integer, :ComparisonType [:one-of ["GREATER_OR_EQUAL" "GREATER" "LESSER_OR_EQUAL" "LESSER" "EQUAL" "NOT_EQUAL" "RANGE"]]}}]}, :HierarchyGroupCondition {:Value string, :HierarchyGroupMatchType [:one-of ["EXACT" "WITH_CHILD_GROUPS"]]}}}}, :MonitorContact {:documentation "Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
", :request {:InstanceId string, :ContactId string, :UserId string, :AllowedMonitorCapabilities [:seq-of [:one-of ["SILENT_MONITOR" "BARGE"]]], :ClientToken string}, :required [:InstanceId :ContactId :UserId], :response {:ContactId string, :ContactArn string}}, :AssociateTrafficDistributionGroupUser {:documentation "Associates an agent with a traffic distribution group.
", :request {:TrafficDistributionGroupId string, :UserId string, :InstanceId string}, :required [:TrafficDistributionGroupId :UserId :InstanceId]}, :StartContactEvaluation {:documentation "Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
", :request {:InstanceId string, :ContactId string, :EvaluationFormId string, :ClientToken string}, :required [:InstanceId :ContactId :EvaluationFormId], :response {:EvaluationId string, :EvaluationArn string}}, :UpdateRoutingProfileQueues {:documentation "Updates the properties associated with a set of queues for a routing profile.
", :request {:InstanceId string, :RoutingProfileId string, :QueueConfigs [:seq-of {:QueueReference {:QueueId string, :Channel [:one-of ["VOICE" "CHAT" "TASK"]]}, :Priority integer, :Delay integer}]}, :required [:InstanceId :RoutingProfileId :QueueConfigs]}, :AssociateLambdaFunction {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
", :request {:InstanceId string, :FunctionArn string}, :required [:InstanceId :FunctionArn]}, :UpdatePrompt {:documentation "Updates a prompt.
", :request {:InstanceId string, :PromptId string, :Name string, :Description string, :S3Uri string}, :required [:InstanceId :PromptId], :response {:PromptARN string, :PromptId string}}, :ListAuthenticationProfiles {:documentation "This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Amazon Connect instance.
", :request {:InstanceId string, :MaxResults integer, :NextToken string}, :required [:InstanceId], :response {:AuthenticationProfileSummaryList [:seq-of {:Id string, :Arn string, :Name string, :IsDefault boolean, :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string}}, :UpdateRoutingProfileAgentAvailabilityTimer {:documentation "Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
", :request {:InstanceId string, :RoutingProfileId string, :AgentAvailabilityTimer [:one-of ["TIME_SINCE_LAST_ACTIVITY" "TIME_SINCE_LAST_INBOUND"]]}, :required [:InstanceId :RoutingProfileId :AgentAvailabilityTimer]}, :ListEvaluationForms {:documentation "Lists evaluation forms in the specified Amazon Connect instance.
", :request {:InstanceId string, :MaxResults integer, :NextToken string}, :required [:InstanceId], :response {:EvaluationFormSummaryList [:seq-of {:EvaluationFormId string, :LastModifiedTime timestamp, :LastActivatedTime timestamp, :EvaluationFormArn string, :ActiveVersion integer, :LatestVersion integer, :Title string, :LastActivatedBy string, :CreatedBy string, :LastModifiedBy string, :CreatedTime timestamp}], :NextToken string}}, :DeleteRoutingProfile {:documentation "Deletes a routing profile.
", :request {:InstanceId string, :RoutingProfileId string}, :required [:InstanceId :RoutingProfileId]}, :CreatePersistentContactAssociation {:documentation "Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
", :request {:InstanceId string, :InitialContactId string, :RehydrationType [:one-of ["ENTIRE_PAST_SESSION" "FROM_SEGMENT"]], :SourceContactId string, :ClientToken string}, :required [:InstanceId :InitialContactId :RehydrationType :SourceContactId], :response {:ContinuedFromContactId string}}, :UpdateRoutingProfileName {:documentation "Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name
or Description
must be provided.
", :request {:InstanceId string, :RoutingProfileId string, :Name string, :Description string}, :required [:InstanceId :RoutingProfileId]}, :CreateInstance {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
", :request {:ClientToken string, :IdentityManagementType [:one-of ["SAML" "CONNECT_MANAGED" "EXISTING_DIRECTORY"]], :InstanceAlias string, :DirectoryId string, :InboundCallsEnabled boolean, :OutboundCallsEnabled boolean, :Tags [:map-of string string]}, :required [:IdentityManagementType :InboundCallsEnabled :OutboundCallsEnabled], :response {:Id string, :Arn string}}, :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, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelTwo {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelThree {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelFour {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}, :LevelFive {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}}, :Tags [:map-of string string], :LastModifiedTime timestamp, :LastModifiedRegion string}}}, :SearchRoutingProfiles {:documentation "Searches routing profiles in an Amazon Connect instance, with optional filtering.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:TagFilter {:OrConditions [:seq-of [:seq-of {:TagKey string, :TagValue string}]], :AndConditions [:seq-of {:TagKey string, :TagValue string}], :TagCondition {:TagKey string, :TagValue string}}}, :SearchCriteria shape/RoutingProfileSearchCriteria}, :required [:InstanceId], :response {:RoutingProfiles [:seq-of {:LastModifiedTime timestamp, :AssociatedQueueIds [:seq-of string], :RoutingProfileArn string, :Tags [:map-of string string], :InstanceId string, :IsDefault boolean, :DefaultOutboundQueueId string, :RoutingProfileId string, :MediaConcurrencies [:seq-of {:Channel [:one-of ["VOICE" "CHAT" "TASK"]], :Concurrency integer, :CrossChannelBehavior {:BehaviorType [:one-of ["ROUTE_CURRENT_CHANNEL_ONLY" "ROUTE_ANY_CHANNEL"]]}}], :LastModifiedRegion string, :AgentAvailabilityTimer [:one-of ["TIME_SINCE_LAST_ACTIVITY" "TIME_SINCE_LAST_INBOUND"]], :Name string, :Description string, :NumberOfAssociatedQueues long, :NumberOfAssociatedUsers long}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/RoutingProfileSearchCriteria {:OrConditions [:seq-of shape/RoutingProfileSearchCriteria], :AndConditions [:seq-of shape/RoutingProfileSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}}, :AssociateSecurityKey {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
", :request {:InstanceId string, :Key string}, :required [:InstanceId :Key], :response {:AssociationId string}}, :UpdateViewContent {:documentation "Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status
is set to SAVED
and performs full content validation if Status
is PUBLISHED
. Note that the $SAVED
alias' content will always be updated, but the $LATEST
alias' content will only be updated if Status
is PUBLISHED
.
", :request {:InstanceId string, :ViewId string, :Status [:one-of ["PUBLISHED" "SAVED"]], :Content {:Template string, :Actions [:seq-of string]}}, :required [:InstanceId :ViewId :Status :Content], :response {:View {:VersionDescription string, :LastModifiedTime timestamp, :ViewContentSha256 string, :Id string, :Tags [:map-of string string], :Arn string, :Name string, :Description string, :Type [:one-of ["CUSTOMER_MANAGED" "AWS_MANAGED"]], :CreatedTime timestamp, :Version integer, :Content {:InputSchema string, :Template string, :Actions [:seq-of string]}, :Status [:one-of ["PUBLISHED" "SAVED"]]}}}, :GetFlowAssociation {:documentation "Retrieves the flow associated for a given resource.
", :request {:InstanceId string, :ResourceId string, :ResourceType [:one-of ["SMS_PHONE_NUMBER"]]}, :required [:InstanceId :ResourceId :ResourceType], :response {:ResourceId string, :FlowId string, :ResourceType [:one-of ["SMS_PHONE_NUMBER"]]}}, :DeleteContactFlowModule {:documentation "Deletes the specified flow module.
", :request {:InstanceId string, :ContactFlowModuleId string}, :required [:InstanceId :ContactFlowModuleId]}, :ListBots {:documentation "This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :LexVersion [:one-of ["V1" "V2"]]}, :required [:InstanceId :LexVersion], :response {:LexBots [:seq-of {:LexBot {:Name string, :LexRegion string}, :LexV2Bot {:AliasArn string}}], :NextToken string}}, :UpdateQueueName {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name
or Description
must be provided.
", :request {:InstanceId string, :QueueId string, :Name string, :Description string}, :required [:InstanceId :QueueId]}, :ResumeContact {:documentation "Allows resuming a task contact in a paused state.
", :request {:ContactId string, :InstanceId string, :ContactFlowId string}, :required [:ContactId :InstanceId]}, :DescribeContactFlow {:documentation "Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content. SAVED
does not initiate validation of the content. SAVED
| PUBLISHED
", :request {:InstanceId string, :ContactFlowId string}, :required [:InstanceId :ContactFlowId], :response {:ContactFlow {:Id string, :Tags [:map-of string string], :Arn string, :Name string, :Description string, :Type [:one-of ["CONTACT_FLOW" "CUSTOMER_QUEUE" "CUSTOMER_HOLD" "CUSTOMER_WHISPER" "AGENT_HOLD" "AGENT_WHISPER" "OUTBOUND_WHISPER" "AGENT_TRANSFER" "QUEUE_TRANSFER"]], :State [:one-of ["ACTIVE" "ARCHIVED"]], :Content string, :Status [:one-of ["PUBLISHED" "SAVED"]]}}}, :StartContactStreaming {:documentation " Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
", :request {:InstanceId string, :ContactId string, :ChatStreamingConfiguration {:StreamingEndpointArn string}, :ClientToken string}, :required [:InstanceId :ContactId :ChatStreamingConfiguration :ClientToken], :response {:StreamingId string}}, :CreateContactFlowModule {:documentation "Creates a flow module for the specified Amazon Connect instance.
", :request {:InstanceId string, :Name string, :Description string, :Content string, :Tags [:map-of string string], :ClientToken string}, :required [:InstanceId :Name :Content], :response {:Id string, :Arn string}}, :AssociateBot {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
", :request {:InstanceId string, :LexBot {:Name string, :LexRegion string}, :LexV2Bot {:AliasArn string}}, :required [:InstanceId]}, :DescribeEvaluationForm {:documentation "Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
", :request {:InstanceId string, :EvaluationFormId string, :EvaluationFormVersion integer}, :required [:InstanceId :EvaluationFormId], :response {:EvaluationForm {:EvaluationFormId string, :LastModifiedTime timestamp, :Items [:seq-of shape/EvaluationFormItem], :EvaluationFormArn string, :Tags [:map-of string string], :Title string, :EvaluationFormVersion integer, :Locked boolean, :ScoringStrategy {:Mode [:one-of ["QUESTION_ONLY" "SECTION_ONLY"]], :Status [:one-of ["ENABLED" "DISABLED"]]}, :CreatedBy string, :Description string, :LastModifiedBy string, :CreatedTime timestamp, :Status [:one-of ["DRAFT" "ACTIVE"]]}}, :refs {shape/EvaluationFormItem {:Section {:Title string, :RefId string, :Instructions string, :Items [:seq-of shape/EvaluationFormItem], :Weight double}, :Question {:Title string, :Instructions string, :RefId string, :NotApplicableEnabled boolean, :QuestionType [:one-of ["TEXT" "SINGLESELECT" "NUMERIC"]], :QuestionTypeProperties {:Numeric {:MinValue integer, :MaxValue integer, :Options [:seq-of {:MinValue integer, :MaxValue integer, :Score integer, :AutomaticFail boolean}], :Automation {:PropertyValue {:Label [:one-of ["OVERALL_CUSTOMER_SENTIMENT_SCORE" "OVERALL_AGENT_SENTIMENT_SCORE" "NON_TALK_TIME" "NON_TALK_TIME_PERCENTAGE" "NUMBER_OF_INTERRUPTIONS" "CONTACT_DURATION" "AGENT_INTERACTION_DURATION" "CUSTOMER_HOLD_TIME"]]}}}, :SingleSelect {:Options [:seq-of {:RefId string, :Text string, :Score integer, :AutomaticFail boolean}], :DisplayAs [:one-of ["DROPDOWN" "RADIO"]], :Automation {:Options [:seq-of {:RuleCategory {:Category string, :Condition [:one-of ["PRESENT" "NOT_PRESENT"]], :OptionRefId string}}], :DefaultOptionRefId string}}}, :Weight double}}}}, :ListQueueQuickConnects {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
", :request {:InstanceId string, :QueueId string, :NextToken string, :MaxResults integer}, :required [:InstanceId :QueueId], :response {:NextToken string, :QuickConnectSummaryList [:seq-of {:Id string, :Arn string, :Name string, :QuickConnectType [:one-of ["USER" "QUEUE" "PHONE_NUMBER"]], :LastModifiedTime timestamp, :LastModifiedRegion string}], :LastModifiedTime timestamp, :LastModifiedRegion string}}, :DeleteTrafficDistributionGroup {:documentation "Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
", :request {:TrafficDistributionGroupId string}, :required [:TrafficDistributionGroupId]}, :GetMetricData {:documentation "Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData
. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
", :request {:InstanceId string, :StartTime timestamp, :EndTime timestamp, :Filters {:Queues [:seq-of string], :Channels [:seq-of [:one-of ["VOICE" "CHAT" "TASK"]]], :RoutingProfiles [:seq-of string], :RoutingStepExpressions [:seq-of string]}, :Groupings [:seq-of [:one-of ["QUEUE" "CHANNEL" "ROUTING_PROFILE" "ROUTING_STEP_EXPRESSION"]]], :HistoricalMetrics [:seq-of {:Name [:one-of ["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"]], :Threshold {:Comparison [:one-of ["LT"]], :ThresholdValue double}, :Statistic [:one-of ["SUM" "MAX" "AVG"]], :Unit [:one-of ["SECONDS" "COUNT" "PERCENT"]]}], :NextToken string, :MaxResults integer}, :required [:InstanceId :StartTime :EndTime :Filters :HistoricalMetrics], :response {:NextToken string, :MetricResults [:seq-of {:Dimensions {:Queue {:Id string, :Arn string}, :Channel [:one-of ["VOICE" "CHAT" "TASK"]], :RoutingProfile {:Id string, :Arn string}, :RoutingStepExpression string}, :Collections [:seq-of {:Metric {:Name [:one-of ["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"]], :Threshold {:Comparison [:one-of ["LT"]], :ThresholdValue double}, :Statistic [:one-of ["SUM" "MAX" "AVG"]], :Unit [:one-of ["SECONDS" "COUNT" "PERCENT"]]}, :Value double}]}]}}, :CreatePredefinedAttribute {:documentation "Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
", :request {:InstanceId string, :Name string, :Values {:StringList [:seq-of string]}}, :required [:InstanceId :Name :Values]}, :ImportPhoneNumber {:documentation "Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber
operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
", :request {:InstanceId string, :SourcePhoneNumberArn string, :PhoneNumberDescription string, :Tags [:map-of string string], :ClientToken string}, :required [:InstanceId :SourcePhoneNumberArn], :response {:PhoneNumberId string, :PhoneNumberArn string}}, :DescribeTrafficDistributionGroup {:documentation "Gets details and status of a traffic distribution group.
", :request {:TrafficDistributionGroupId string}, :required [:TrafficDistributionGroupId], :response {:TrafficDistributionGroup {:Id string, :Arn string, :Name string, :Description string, :InstanceArn string, :Status [:one-of ["CREATION_IN_PROGRESS" "ACTIVE" "CREATION_FAILED" "PENDING_DELETION" "DELETION_FAILED" "UPDATE_IN_PROGRESS"]], :Tags [:map-of string string], :IsDefault boolean}}}, :DeleteHoursOfOperation {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
", :request {:InstanceId string, :HoursOfOperationId string}, :required [:InstanceId :HoursOfOperationId]}, :GetTrafficDistribution {:documentation "Retrieves the current traffic distribution for a given traffic distribution group.
", :request {:Id string}, :required [:Id], :response {:TelephonyConfig {:Distributions [:seq-of {:Region string, :Percentage integer}]}, :Id string, :Arn string, :SignInConfig {:Distributions [:seq-of {:Region string, :Enabled boolean}]}, :AgentConfig {:Distributions [:seq-of {:Region string, :Percentage integer}]}}}, :GetCurrentUserData {:documentation "Gets the real-time active user data from the specified Amazon Connect instance.
", :request {:InstanceId string, :Filters {:Queues [:seq-of string], :ContactFilter {:ContactStates [:seq-of [:one-of ["INCOMING" "PENDING" "CONNECTING" "CONNECTED" "CONNECTED_ONHOLD" "MISSED" "ERROR" "ENDED" "REJECTED"]]]}, :RoutingProfiles [:seq-of string], :Agents [:seq-of string], :UserHierarchyGroups [:seq-of string]}, :NextToken string, :MaxResults integer}, :required [:InstanceId :Filters], :response {:NextToken string, :UserDataList [:seq-of {:HierarchyPath {:LevelOne {:Id string, :Arn string}, :LevelTwo {:Id string, :Arn string}, :LevelThree {:Id string, :Arn string}, :LevelFour {:Id string, :Arn string}, :LevelFive {:Id string, :Arn string}}, :ActiveSlotsByChannel [:map-of [:one-of ["VOICE" "CHAT" "TASK"]] integer], :Contacts [:seq-of {:ContactId string, :Channel [:one-of ["VOICE" "CHAT" "TASK"]], :InitiationMethod [:one-of ["INBOUND" "OUTBOUND" "TRANSFER" "QUEUE_TRANSFER" "CALLBACK" "API" "DISCONNECT" "MONITOR" "EXTERNAL_OUTBOUND"]], :AgentContactState [:one-of ["INCOMING" "PENDING" "CONNECTING" "CONNECTED" "CONNECTED_ONHOLD" "MISSED" "ERROR" "ENDED" "REJECTED"]], :StateStartTimestamp timestamp, :ConnectedToAgentTimestamp timestamp, :Queue {:Id string, :Arn string}}], :MaxSlotsByChannel [:map-of [:one-of ["VOICE" "CHAT" "TASK"]] integer], :NextStatus string, :User {:Id string, :Arn string}, :RoutingProfile {:Id string, :Arn string}, :AvailableSlotsByChannel [:map-of [:one-of ["VOICE" "CHAT" "TASK"]] integer], :Status {:StatusStartTimestamp timestamp, :StatusArn string, :StatusName string}}], :ApproximateTotalCount long}}, :DeleteContactFlow {:documentation "Deletes a flow for the specified Amazon Connect instance.
", :request {:InstanceId string, :ContactFlowId string}, :required [:InstanceId :ContactFlowId]}, :DescribeRule {:documentation "Describes a rule for the specified Amazon Connect instance.
", :request {:InstanceId string, :RuleId string}, :required [:InstanceId :RuleId], :response {:Rule {:Function string, :Actions [:seq-of {:CreateCaseAction {:Fields [:seq-of {:Id string, :Value {:BooleanValue boolean, :DoubleValue double, :EmptyValue {}, :StringValue string}}], :TemplateId string}, :ActionType [:one-of ["CREATE_TASK" "ASSIGN_CONTACT_CATEGORY" "GENERATE_EVENTBRIDGE_EVENT" "SEND_NOTIFICATION" "CREATE_CASE" "UPDATE_CASE" "END_ASSOCIATED_TASKS" "SUBMIT_AUTO_EVALUATION"]], :SubmitAutoEvaluationAction {:EvaluationFormId string}, :EndAssociatedTasksAction {}, :UpdateCaseAction {:Fields [:seq-of {:Id string, :Value {:BooleanValue boolean, :DoubleValue double, :EmptyValue {}, :StringValue string}}]}, :EventBridgeAction {:Name string}, :TaskAction {:Name string, :Description string, :ContactFlowId string, :References [:map-of string {:Value string, :Type [:one-of ["URL" "ATTACHMENT" "NUMBER" "STRING" "DATE" "EMAIL"]]}]}, :AssignContactCategoryAction {}, :SendNotificationAction {:DeliveryMethod [:one-of ["EMAIL"]], :Subject string, :Content string, :ContentType [:one-of ["PLAIN_TEXT"]], :Recipient {:UserTags [:map-of string string], :UserIds [:seq-of string]}}}], :RuleArn string, :LastUpdatedTime timestamp, :Tags [:map-of string string], :RuleId string, :PublishStatus [:one-of ["DRAFT" "PUBLISHED"]], :Name string, :CreatedTime timestamp, :LastUpdatedBy string, :TriggerEventSource {:EventSourceName [:one-of ["OnPostCallAnalysisAvailable" "OnRealTimeCallAnalysisAvailable" "OnRealTimeChatAnalysisAvailable" "OnPostChatAnalysisAvailable" "OnZendeskTicketCreate" "OnZendeskTicketStatusUpdate" "OnSalesforceCaseCreate" "OnContactEvaluationSubmit" "OnMetricDataUpdate" "OnCaseCreate" "OnCaseUpdate"]], :IntegrationAssociationId string}}}}, :DeleteUserHierarchyGroup {:documentation "Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
", :request {:HierarchyGroupId string, :InstanceId string}, :required [:HierarchyGroupId :InstanceId]}, :UpdateContactRoutingData {:documentation "Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
", :request {:InstanceId string, :ContactId string, :QueueTimeAdjustmentSeconds integer, :QueuePriority long, :RoutingCriteria {:Steps [:seq-of {:Expiry {:DurationInSeconds integer}, :Expression shape/Expression}]}}, :required [:InstanceId :ContactId], :refs {shape/Expression {:AttributeCondition {:Name string, :Value string, :ProficiencyLevel float, :MatchCriteria {:AgentsCriteria {:AgentIds [:seq-of string]}}, :ComparisonOperator string}, :AndExpression [:seq-of shape/Expression], :OrExpression [:seq-of shape/Expression]}}}, :SearchContacts {:documentation "Searches contacts in an Amazon Connect instance.
", :request {:InstanceId string, :TimeRange {:Type [:one-of ["INITIATION_TIMESTAMP" "SCHEDULED_TIMESTAMP" "CONNECTED_TO_AGENT_TIMESTAMP" "DISCONNECT_TIMESTAMP"]], :StartTime timestamp, :EndTime timestamp}, :SearchCriteria {:AgentIds [:seq-of string], :AgentHierarchyGroups {:L1Ids [:seq-of string], :L2Ids [:seq-of string], :L3Ids [:seq-of string], :L4Ids [:seq-of string], :L5Ids [:seq-of string]}, :Channels [:seq-of [:one-of ["VOICE" "CHAT" "TASK"]]], :ContactAnalysis {:Transcript {:Criteria [:seq-of {:ParticipantRole [:one-of ["AGENT" "CUSTOMER" "SYSTEM" "CUSTOM_BOT" "SUPERVISOR"]], :SearchText [:seq-of string], :MatchType [:one-of ["MATCH_ALL" "MATCH_ANY"]]}], :MatchType [:one-of ["MATCH_ALL" "MATCH_ANY"]]}}, :InitiationMethods [:seq-of [:one-of ["INBOUND" "OUTBOUND" "TRANSFER" "QUEUE_TRANSFER" "CALLBACK" "API" "DISCONNECT" "MONITOR" "EXTERNAL_OUTBOUND"]]], :QueueIds [:seq-of string], :SearchableContactAttributes {:Criteria [:seq-of {:Key string, :Values [:seq-of string]}], :MatchType [:one-of ["MATCH_ALL" "MATCH_ANY"]]}}, :MaxResults integer, :NextToken string, :Sort {:FieldName [:one-of ["INITIATION_TIMESTAMP" "SCHEDULED_TIMESTAMP" "CONNECTED_TO_AGENT_TIMESTAMP" "DISCONNECT_TIMESTAMP" "INITIATION_METHOD" "CHANNEL"]], :Order [:one-of ["ASCENDING" "DESCENDING"]]}}, :required [:InstanceId :TimeRange], :response {:Contacts [:seq-of {:InitialContactId string, :QueueInfo {:Id string, :EnqueueTimestamp timestamp}, :PreviousContactId string, :AgentInfo {:Id string, :ConnectedToAgentTimestamp timestamp}, :Id string, :Channel [:one-of ["VOICE" "CHAT" "TASK"]], :DisconnectTimestamp timestamp, :ScheduledTimestamp timestamp, :InitiationMethod [:one-of ["INBOUND" "OUTBOUND" "TRANSFER" "QUEUE_TRANSFER" "CALLBACK" "API" "DISCONNECT" "MONITOR" "EXTERNAL_OUTBOUND"]], :Arn string, :InitiationTimestamp timestamp}], :NextToken string, :TotalCount long}}, :UpdateContact {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
", :request {:InstanceId string, :ContactId string, :Name string, :Description string, :References [:map-of string {:Value string, :Type [:one-of ["URL" "ATTACHMENT" "NUMBER" "STRING" "DATE" "EMAIL"]]}]}, :required [:InstanceId :ContactId]}, :DescribeAgentStatus {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
", :request {:InstanceId string, :AgentStatusId string}, :required [:InstanceId :AgentStatusId], :response {:AgentStatus {:LastModifiedTime timestamp, :DisplayOrder integer, :Tags [:map-of string string], :AgentStatusARN string, :LastModifiedRegion string, :Name string, :Description string, :AgentStatusId string, :Type [:one-of ["ROUTABLE" "CUSTOM" "OFFLINE"]], :State [:one-of ["ENABLED" "DISABLED"]]}}}, :GetTaskTemplate {:documentation "Gets details about a specific task template in the specified Amazon Connect instance.
", :request {:InstanceId string, :TaskTemplateId string, :SnapshotVersion string}, :required [:InstanceId :TaskTemplateId], :response {:LastModifiedTime timestamp, :Id string, :Tags [:map-of string string], :InstanceId string, :ContactFlowId string, :Constraints {:RequiredFields [:seq-of {:Id {:Name string}}], :ReadOnlyFields [:seq-of {:Id {:Name string}}], :InvisibleFields [:seq-of {:Id {:Name string}}]}, :Arn string, :Defaults {:DefaultFieldValues [:seq-of {:Id {:Name string}, :DefaultValue string}]}, :Name string, :Description string, :CreatedTime timestamp, :Fields [:seq-of {:Id {:Name string}, :Description string, :Type [:one-of ["NAME" "DESCRIPTION" "SCHEDULED_TIME" "QUICK_CONNECT" "URL" "NUMBER" "TEXT" "TEXT_AREA" "DATE_TIME" "BOOLEAN" "SINGLE_SELECT" "EMAIL"]], :SingleSelectOptions [:seq-of string]}], :Status [:one-of ["ACTIVE" "INACTIVE"]]}}, :DeleteIntegrationAssociation {:documentation "Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
", :request {:InstanceId string, :IntegrationAssociationId string}, :required [:InstanceId :IntegrationAssociationId]}, :DisassociateAnalyticsDataSet {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
", :request {:InstanceId string, :DataSetId string, :TargetAccountId string}, :required [:InstanceId :DataSetId]}, :DeactivateEvaluationForm {:documentation "Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
", :request {:InstanceId string, :EvaluationFormId string, :EvaluationFormVersion integer}, :required [:InstanceId :EvaluationFormId :EvaluationFormVersion], :response {:EvaluationFormId string, :EvaluationFormArn string, :EvaluationFormVersion integer}}, :DescribeContactFlowModule {:documentation "Describes the specified flow module.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
", :request {:InstanceId string, :ContactFlowModuleId string}, :required [:InstanceId :ContactFlowModuleId], :response {:ContactFlowModule {:Arn string, :Id string, :Name string, :Content string, :Description string, :State [:one-of ["ACTIVE" "ARCHIVED"]], :Status [:one-of ["PUBLISHED" "SAVED"]], :Tags [:map-of string string]}}}, :UpdateQuickConnectName {:documentation "Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name
or Description
must be provided.
", :request {:InstanceId string, :QuickConnectId string, :Name string, :Description string}, :required [:InstanceId :QuickConnectId]}, :AssociatePhoneNumberContactFlow {:documentation "Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
", :request {:PhoneNumberId string, :InstanceId string, :ContactFlowId string}, :required [:PhoneNumberId :InstanceId :ContactFlowId]}, :CreateEvaluationForm {:documentation "Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
", :request {:InstanceId string, :Title string, :Description string, :Items [:seq-of shape/EvaluationFormItem], :ScoringStrategy {:Mode [:one-of ["QUESTION_ONLY" "SECTION_ONLY"]], :Status [:one-of ["ENABLED" "DISABLED"]]}, :ClientToken string}, :required [:InstanceId :Title :Items], :response {:EvaluationFormId string, :EvaluationFormArn string}, :refs {shape/EvaluationFormItem {:Section {:Title string, :RefId string, :Instructions string, :Items [:seq-of shape/EvaluationFormItem], :Weight double}, :Question {:Title string, :Instructions string, :RefId string, :NotApplicableEnabled boolean, :QuestionType [:one-of ["TEXT" "SINGLESELECT" "NUMERIC"]], :QuestionTypeProperties {:Numeric {:MinValue integer, :MaxValue integer, :Options [:seq-of {:MinValue integer, :MaxValue integer, :Score integer, :AutomaticFail boolean}], :Automation {:PropertyValue {:Label [:one-of ["OVERALL_CUSTOMER_SENTIMENT_SCORE" "OVERALL_AGENT_SENTIMENT_SCORE" "NON_TALK_TIME" "NON_TALK_TIME_PERCENTAGE" "NUMBER_OF_INTERRUPTIONS" "CONTACT_DURATION" "AGENT_INTERACTION_DURATION" "CUSTOMER_HOLD_TIME"]]}}}, :SingleSelect {:Options [:seq-of {:RefId string, :Text string, :Score integer, :AutomaticFail boolean}], :DisplayAs [:one-of ["DROPDOWN" "RADIO"]], :Automation {:Options [:seq-of {:RuleCategory {:Category string, :Condition [:one-of ["PRESENT" "NOT_PRESENT"]], :OptionRefId string}}], :DefaultOptionRefId string}}}, :Weight double}}}}, :ListSecurityProfilePermissions {:documentation "Lists the permissions granted to a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", :request {:SecurityProfileId string, :InstanceId string, :NextToken string, :MaxResults integer}, :required [:SecurityProfileId :InstanceId], :response {:Permissions [:seq-of string], :NextToken string, :LastModifiedTime timestamp, :LastModifiedRegion string}}, :DescribeHoursOfOperation {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
", :request {:InstanceId string, :HoursOfOperationId string}, :required [:InstanceId :HoursOfOperationId], :response {:HoursOfOperation {:LastModifiedTime timestamp, :Config [:seq-of {:Day [:one-of ["SUNDAY" "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY"]], :StartTime {:Hours integer, :Minutes integer}, :EndTime {:Hours integer, :Minutes integer}}], :HoursOfOperationArn string, :Tags [:map-of string string], :TimeZone string, :LastModifiedRegion string, :Name string, :Description string, :HoursOfOperationId string}}}, :ListInstanceStorageConfigs {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
", :request {:InstanceId string, :ResourceType [:one-of ["CHAT_TRANSCRIPTS" "CALL_RECORDINGS" "SCHEDULED_REPORTS" "MEDIA_STREAMS" "CONTACT_TRACE_RECORDS" "AGENT_EVENTS" "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" "ATTACHMENTS" "CONTACT_EVALUATIONS" "SCREEN_RECORDINGS" "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS" "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS"]], :NextToken string, :MaxResults integer}, :required [:InstanceId :ResourceType], :response {:StorageConfigs [:seq-of {:AssociationId string, :StorageType [:one-of ["S3" "KINESIS_VIDEO_STREAM" "KINESIS_STREAM" "KINESIS_FIREHOSE"]], :S3Config {:BucketName string, :BucketPrefix string, :EncryptionConfig {:EncryptionType [:one-of ["KMS"]], :KeyId string}}, :KinesisVideoStreamConfig {:Prefix string, :RetentionPeriodHours integer, :EncryptionConfig {:EncryptionType [:one-of ["KMS"]], :KeyId string}}, :KinesisStreamConfig {:StreamArn string}, :KinesisFirehoseConfig {:FirehoseArn string}}], :NextToken string}}, :DeleteQuickConnect {:documentation "Deletes a quick connect.
After calling DeleteUser, it's important to call DeleteQuickConnect
to delete any records related to the deleted users. This will help you:
-
Avoid dangling resources that impact your service quotas.
-
Remove deleted users so they don't appear to agents as transfer options.
-
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
", :request {:InstanceId string, :QuickConnectId string}, :required [:InstanceId :QuickConnectId]}, :DisassociatePhoneNumberContactFlow {:documentation "Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
", :request {:PhoneNumberId string, :InstanceId string}, :required [:PhoneNumberId :InstanceId]}, :SendChatIntegrationEvent {:documentation "Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
-
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
-
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
", :request {:SourceId string, :DestinationId string, :Subtype string, :Event {:Type [:one-of ["DISCONNECT" "MESSAGE" "EVENT"]], :ContentType string, :Content string}, :NewSessionDetails {:SupportedMessagingContentTypes [:seq-of string], :ParticipantDetails {:DisplayName string}, :Attributes [:map-of string string], :StreamingConfiguration {:StreamingEndpointArn string}}}, :required [:SourceId :DestinationId :Event], :response {:InitialContactId string, :NewChatCreated boolean}}, :UpdateContactSchedule {:documentation "Updates the scheduled time of a task contact that is already scheduled.
", :request {:InstanceId string, :ContactId string, :ScheduledTime timestamp}, :required [:InstanceId :ContactId :ScheduledTime]}, :CreateIntegrationAssociation {:documentation "Creates an Amazon Web Services resource association with an Amazon Connect instance.
", :request {:InstanceId string, :IntegrationType [:one-of ["EVENT" "VOICE_ID" "PINPOINT_APP" "WISDOM_ASSISTANT" "WISDOM_KNOWLEDGE_BASE" "WISDOM_QUICK_RESPONSES" "CASES_DOMAIN" "APPLICATION" "FILE_SCANNER"]], :IntegrationArn string, :SourceApplicationUrl string, :SourceApplicationName string, :SourceType [:one-of ["SALESFORCE" "ZENDESK" "CASES"]], :Tags [:map-of string string]}, :required [:InstanceId :IntegrationType :IntegrationArn], :response {:IntegrationAssociationId string, :IntegrationAssociationArn string}}, :UpdateViewMetadata {:documentation "Updates the view metadata. Note that either Name
or Description
must be provided.
", :request {:InstanceId string, :ViewId string, :Name string, :Description string}, :required [:InstanceId :ViewId]}, :AssociateFlow {:documentation "Associates a connect resource to a flow.
", :request {:InstanceId string, :ResourceId string, :FlowId string, :ResourceType [:one-of ["SMS_PHONE_NUMBER"]]}, :required [:InstanceId :ResourceId :FlowId :ResourceType]}, :SearchPrompts {:documentation "Searches prompts in an Amazon Connect instance, with optional filtering.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:TagFilter {:OrConditions [:seq-of [:seq-of {:TagKey string, :TagValue string}]], :AndConditions [:seq-of {:TagKey string, :TagValue string}], :TagCondition {:TagKey string, :TagValue string}}}, :SearchCriteria shape/PromptSearchCriteria}, :required [:InstanceId], :response {:Prompts [:seq-of {:PromptARN string, :PromptId string, :Name string, :Description string, :Tags [:map-of string string], :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/PromptSearchCriteria {:OrConditions [:seq-of shape/PromptSearchCriteria], :AndConditions [:seq-of shape/PromptSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}}, :DeleteEvaluationForm {:documentation "Deletes an evaluation form in the specified Amazon Connect instance.
-
If the version property is provided, only the specified version of the evaluation form is deleted.
-
If no version is provided, then the full form (all versions) is deleted.
", :request {:InstanceId string, :EvaluationFormId string, :EvaluationFormVersion integer}, :required [:InstanceId :EvaluationFormId]}, :DisassociateRoutingProfileQueues {:documentation "Disassociates a set of queues from a routing profile.
", :request {:InstanceId string, :RoutingProfileId string, :QueueReferences [:seq-of {:QueueId string, :Channel [:one-of ["VOICE" "CHAT" "TASK"]]}]}, :required [:InstanceId :RoutingProfileId :QueueReferences]}, :ListTrafficDistributionGroupUsers {:documentation "Lists traffic distribution group users.
", :request {:TrafficDistributionGroupId string, :MaxResults integer, :NextToken string}, :required [:TrafficDistributionGroupId], :response {:NextToken string, :TrafficDistributionGroupUserSummaryList [:seq-of {:UserId string}]}}, :AssociateAnalyticsDataSet {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
", :request {:InstanceId string, :DataSetId string, :TargetAccountId string}, :required [:InstanceId :DataSetId], :response {:DataSetId string, :TargetAccountId string, :ResourceShareId string, :ResourceShareArn string}}, :UpdateContactFlowContent {:documentation "Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
", :request {:InstanceId string, :ContactFlowId string, :Content string}, :required [:InstanceId :ContactFlowId :Content]}, :DeletePrompt {:documentation "Deletes a prompt.
", :request {:InstanceId string, :PromptId string}, :required [:InstanceId :PromptId]}, :ListTaskTemplates {:documentation "Lists task templates for the specified Amazon Connect instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :Status [:one-of ["ACTIVE" "INACTIVE"]], :Name string}, :required [:InstanceId], :response {:TaskTemplates [:seq-of {:Id string, :Arn string, :Name string, :Description string, :Status [:one-of ["ACTIVE" "INACTIVE"]], :LastModifiedTime timestamp, :CreatedTime timestamp}], :NextToken string}}, :ClaimPhoneNumber {:documentation "Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
", :request {:TargetArn string, :InstanceId string, :PhoneNumber string, :PhoneNumberDescription string, :Tags [:map-of string string], :ClientToken string}, :required [:PhoneNumber], :response {:PhoneNumberId string, :PhoneNumberArn string}}, :UpdateInstanceStorageConfig {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
", :request {:InstanceId string, :AssociationId string, :ResourceType [:one-of ["CHAT_TRANSCRIPTS" "CALL_RECORDINGS" "SCHEDULED_REPORTS" "MEDIA_STREAMS" "CONTACT_TRACE_RECORDS" "AGENT_EVENTS" "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" "ATTACHMENTS" "CONTACT_EVALUATIONS" "SCREEN_RECORDINGS" "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS" "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS"]], :StorageConfig {:AssociationId string, :StorageType [:one-of ["S3" "KINESIS_VIDEO_STREAM" "KINESIS_STREAM" "KINESIS_FIREHOSE"]], :S3Config {:BucketName string, :BucketPrefix string, :EncryptionConfig {:EncryptionType [:one-of ["KMS"]], :KeyId string}}, :KinesisVideoStreamConfig {:Prefix string, :RetentionPeriodHours integer, :EncryptionConfig {:EncryptionType [:one-of ["KMS"]], :KeyId string}}, :KinesisStreamConfig {:StreamArn string}, :KinesisFirehoseConfig {:FirehoseArn string}}}, :required [:InstanceId :AssociationId :ResourceType :StorageConfig]}, :CreateViewVersion {:documentation "Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST
alias.
", :request {:InstanceId string, :ViewId string, :VersionDescription string, :ViewContentSha256 string}, :required [:InstanceId :ViewId], :response {:View {:VersionDescription string, :LastModifiedTime timestamp, :ViewContentSha256 string, :Id string, :Tags [:map-of string string], :Arn string, :Name string, :Description string, :Type [:one-of ["CUSTOMER_MANAGED" "AWS_MANAGED"]], :CreatedTime timestamp, :Version integer, :Content {:InputSchema string, :Template string, :Actions [:seq-of string]}, :Status [:one-of ["PUBLISHED" "SAVED"]]}}}, :ListDefaultVocabularies {:documentation "Lists the default vocabularies for the specified Amazon Connect instance.
", :request {:InstanceId string, :LanguageCode [:one-of ["ar-AE" "de-CH" "de-DE" "en-AB" "en-AU" "en-GB" "en-IE" "en-IN" "en-US" "en-WL" "es-ES" "es-US" "fr-CA" "fr-FR" "hi-IN" "it-IT" "ja-JP" "ko-KR" "pt-BR" "pt-PT" "zh-CN" "en-NZ" "en-ZA" "ca-ES" "da-DK" "fi-FI" "id-ID" "ms-MY" "nl-NL" "no-NO" "pl-PL" "sv-SE" "tl-PH"]], :MaxResults integer, :NextToken string}, :required [:InstanceId], :response {:DefaultVocabularyList [:seq-of {:InstanceId string, :LanguageCode [:one-of ["ar-AE" "de-CH" "de-DE" "en-AB" "en-AU" "en-GB" "en-IE" "en-IN" "en-US" "en-WL" "es-ES" "es-US" "fr-CA" "fr-FR" "hi-IN" "it-IT" "ja-JP" "ko-KR" "pt-BR" "pt-PT" "zh-CN" "en-NZ" "en-ZA" "ca-ES" "da-DK" "fi-FI" "id-ID" "ms-MY" "nl-NL" "no-NO" "pl-PL" "sv-SE" "tl-PH"]], :VocabularyId string, :VocabularyName string}], :NextToken string}}, :AssociateLexBot {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
", :request {:InstanceId string, :LexBot {:Name string, :LexRegion string}}, :required [:InstanceId :LexBot]}, :StartWebRTCContact {:documentation "Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
", :request {:References [:map-of string {:Value string, :Type [:one-of ["URL" "ATTACHMENT" "NUMBER" "STRING" "DATE" "EMAIL"]]}], :InstanceId string, :ContactFlowId string, :ParticipantDetails {:DisplayName string}, :RelatedContactId string, :Description string, :ClientToken string, :Attributes [:map-of string string], :AllowedCapabilities {:Customer {:Video [:one-of ["SEND"]]}, :Agent {:Video [:one-of ["SEND"]]}}}, :required [:ContactFlowId :InstanceId :ParticipantDetails], :response {:ConnectionData {:Attendee {:AttendeeId string, :JoinToken string}, :Meeting {:MediaRegion string, :MediaPlacement {:AudioHostUrl string, :AudioFallbackUrl string, :SignalingUrl string, :TurnControlUrl string, :EventIngestionUrl string}, :MeetingFeatures {:Audio {:EchoReduction [:one-of ["AVAILABLE" "UNAVAILABLE"]]}}, :MeetingId string}}, :ContactId string, :ParticipantId string, :ParticipantToken string}}, :CreateParticipant {:documentation "Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
", :request {:InstanceId string, :ContactId string, :ClientToken string, :ParticipantDetails {:ParticipantRole [:one-of ["AGENT" "CUSTOMER" "SYSTEM" "CUSTOM_BOT" "SUPERVISOR"]], :DisplayName string}}, :required [:InstanceId :ContactId :ParticipantDetails], :response {:ParticipantCredentials {:ParticipantToken string, :Expiry string}, :ParticipantId string}}, :ListContactEvaluations {:documentation "Lists contact evaluations in the specified Amazon Connect instance.
", :request {:InstanceId string, :ContactId string, :NextToken string}, :required [:InstanceId :ContactId], :response {:EvaluationSummaryList [:seq-of {:EvaluationFormId string, :LastModifiedTime timestamp, :Score {:Percentage double, :NotApplicable boolean, :AutomaticFail boolean}, :EvaluationArn string, :CreatedTime timestamp, :EvaluatorArn string, :EvaluationFormTitle string, :EvaluationId string, :Status [:one-of ["DRAFT" "SUBMITTED"]]}], :NextToken string}}, :UpdatePhoneNumber {:documentation "Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
", :request {:PhoneNumberId string, :TargetArn string, :InstanceId string, :ClientToken string}, :required [:PhoneNumberId], :response {:PhoneNumberId string, :PhoneNumberArn string}}, :UpdateQuickConnectConfig {:documentation "Updates the configuration settings for the specified quick connect.
", :request {:InstanceId string, :QuickConnectId string, :QuickConnectConfig {:QuickConnectType [:one-of ["USER" "QUEUE" "PHONE_NUMBER"]], :UserConfig {:UserId string, :ContactFlowId string}, :QueueConfig {:QueueId string, :ContactFlowId string}, :PhoneConfig {:PhoneNumber string}}}, :required [:InstanceId :QuickConnectId :QuickConnectConfig]}, :DescribeRoutingProfile {:documentation "Describes the specified routing profile.
", :request {:InstanceId string, :RoutingProfileId string}, :required [:InstanceId :RoutingProfileId], :response {:RoutingProfile {:LastModifiedTime timestamp, :AssociatedQueueIds [:seq-of string], :RoutingProfileArn string, :Tags [:map-of string string], :InstanceId string, :IsDefault boolean, :DefaultOutboundQueueId string, :RoutingProfileId string, :MediaConcurrencies [:seq-of {:Channel [:one-of ["VOICE" "CHAT" "TASK"]], :Concurrency integer, :CrossChannelBehavior {:BehaviorType [:one-of ["ROUTE_CURRENT_CHANNEL_ONLY" "ROUTE_ANY_CHANNEL"]]}}], :LastModifiedRegion string, :AgentAvailabilityTimer [:one-of ["TIME_SINCE_LAST_ACTIVITY" "TIME_SINCE_LAST_INBOUND"]], :Name string, :Description string, :NumberOfAssociatedQueues long, :NumberOfAssociatedUsers long}}}, :DescribeInstance {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
", :request {:InstanceId string}, :required [:InstanceId], :response {:Instance {:OutboundCallsEnabled boolean, :StatusReason {:Message string}, :Id string, :Tags [:map-of string string], :InstanceAlias string, :IdentityManagementType [:one-of ["SAML" "CONNECT_MANAGED" "EXISTING_DIRECTORY"]], :InstanceStatus [:one-of ["CREATION_IN_PROGRESS" "ACTIVE" "CREATION_FAILED"]], :ServiceRole string, :InstanceAccessUrl string, :Arn string, :CreatedTime timestamp, :InboundCallsEnabled boolean}, :ReplicationConfiguration {:ReplicationStatusSummaryList [:seq-of {:Region string, :ReplicationStatus [:one-of ["INSTANCE_REPLICATION_COMPLETE" "INSTANCE_REPLICATION_IN_PROGRESS" "INSTANCE_REPLICATION_FAILED" "INSTANCE_REPLICA_DELETING" "INSTANCE_REPLICATION_DELETION_FAILED" "RESOURCE_REPLICATION_NOT_STARTED"]], :ReplicationStatusReason string}], :SourceRegion string, :GlobalSignInEndpoint string}}}, :DeleteUser {:documentation "Deletes 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 Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
-
Avoid dangling resources that impact your service quotas.
-
Remove deleted users so they don't appear to agents as transfer options.
-
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
", :request {:InstanceId string, :UserId string}, :required [:InstanceId :UserId]}, :DescribeQueue {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
", :request {:InstanceId string, :QueueId string}, :required [:InstanceId :QueueId], :response {:Queue {:QueueArn string, :LastModifiedTime timestamp, :QueueId string, :Tags [:map-of string string], :MaxContacts integer, :OutboundCallerConfig {:OutboundCallerIdName string, :OutboundCallerIdNumberId string, :OutboundFlowId string}, :LastModifiedRegion string, :Name string, :Description string, :HoursOfOperationId string, :Status [:one-of ["ENABLED" "DISABLED"]]}}}, :PauseContact {:documentation "Allows pausing an ongoing task contact.
", :request {:ContactId string, :InstanceId string, :ContactFlowId string}, :required [:ContactId :InstanceId]}, :ListIntegrationAssociations {:documentation "Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
", :request {:InstanceId string, :IntegrationType [:one-of ["EVENT" "VOICE_ID" "PINPOINT_APP" "WISDOM_ASSISTANT" "WISDOM_KNOWLEDGE_BASE" "WISDOM_QUICK_RESPONSES" "CASES_DOMAIN" "APPLICATION" "FILE_SCANNER"]], :NextToken string, :MaxResults integer, :IntegrationArn string}, :required [:InstanceId], :response {:IntegrationAssociationSummaryList [:seq-of {:IntegrationAssociationId string, :IntegrationAssociationArn string, :InstanceId string, :IntegrationType [:one-of ["EVENT" "VOICE_ID" "PINPOINT_APP" "WISDOM_ASSISTANT" "WISDOM_KNOWLEDGE_BASE" "WISDOM_QUICK_RESPONSES" "CASES_DOMAIN" "APPLICATION" "FILE_SCANNER"]], :IntegrationArn string, :SourceApplicationUrl string, :SourceApplicationName string, :SourceType [:one-of ["SALESFORCE" "ZENDESK" "CASES"]]}], :NextToken string}}, :TransferContact {:documentation "Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
-
Transfer is supported for only TASK
contacts.
-
Do not use both QueueId
and UserId
in the same call.
-
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
-
The TransferContact
API can be called only on active contacts.
-
A contact cannot be transferred more than 11 times.
", :request {:InstanceId string, :ContactId string, :QueueId string, :UserId string, :ContactFlowId string, :ClientToken string}, :required [:InstanceId :ContactId :ContactFlowId], :response {:ContactId string, :ContactArn string}}, :CreateHoursOfOperation {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
", :request {:InstanceId string, :Name string, :Description string, :TimeZone string, :Config [:seq-of {:Day [:one-of ["SUNDAY" "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY"]], :StartTime {:Hours integer, :Minutes integer}, :EndTime {:Hours integer, :Minutes integer}}], :Tags [:map-of string string]}, :required [:InstanceId :Name :TimeZone :Config], :response {:HoursOfOperationId string, :HoursOfOperationArn string}}, :BatchAssociateAnalyticsDataSet {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
", :request {:InstanceId string, :DataSetIds [:seq-of string], :TargetAccountId string}, :required [:InstanceId :DataSetIds], :response {:Created [:seq-of {:DataSetId string, :TargetAccountId string, :ResourceShareId string, :ResourceShareArn string}], :Errors [:seq-of {:ErrorCode string, :ErrorMessage string}]}}, :AssociateApprovedOrigin {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
", :request {:InstanceId string, :Origin string}, :required [:InstanceId :Origin]}, :ListEvaluationFormVersions {:documentation "Lists versions of an evaluation form in the specified Amazon Connect instance.
", :request {:InstanceId string, :EvaluationFormId string, :MaxResults integer, :NextToken string}, :required [:InstanceId :EvaluationFormId], :response {:EvaluationFormVersionSummaryList [:seq-of {:EvaluationFormId string, :LastModifiedTime timestamp, :EvaluationFormArn string, :EvaluationFormVersion integer, :Locked boolean, :CreatedBy string, :LastModifiedBy string, :CreatedTime timestamp, :Status [:one-of ["DRAFT" "ACTIVE"]]}], :NextToken string}}, :ListContactFlows {:documentation "Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
", :request {:InstanceId string, :ContactFlowTypes [:seq-of [:one-of ["CONTACT_FLOW" "CUSTOMER_QUEUE" "CUSTOMER_HOLD" "CUSTOMER_WHISPER" "AGENT_HOLD" "AGENT_WHISPER" "OUTBOUND_WHISPER" "AGENT_TRANSFER" "QUEUE_TRANSFER"]]], :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:ContactFlowSummaryList [:seq-of {:Id string, :Arn string, :Name string, :ContactFlowType [:one-of ["CONTACT_FLOW" "CUSTOMER_QUEUE" "CUSTOMER_HOLD" "CUSTOMER_WHISPER" "AGENT_HOLD" "AGENT_WHISPER" "OUTBOUND_WHISPER" "AGENT_TRANSFER" "QUEUE_TRANSFER"]], :ContactFlowState [:one-of ["ACTIVE" "ARCHIVED"]], :ContactFlowStatus [:one-of ["PUBLISHED" "SAVED"]]}], :NextToken string}}, :ListInstanceAttributes {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:Attributes [:seq-of {:AttributeType [:one-of ["INBOUND_CALLS" "OUTBOUND_CALLS" "CONTACTFLOW_LOGS" "CONTACT_LENS" "AUTO_RESOLVE_BEST_VOICES" "USE_CUSTOM_TTS_VOICES" "EARLY_MEDIA" "MULTI_PARTY_CONFERENCE" "HIGH_VOLUME_OUTBOUND" "ENHANCED_CONTACT_MONITORING" "ENHANCED_CHAT_MONITORING"]], :Value string}], :NextToken string}}, :CreateSecurityProfile {:documentation "Creates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", :request {:HierarchyRestrictedResources [:seq-of string], :Tags [:map-of string string], :InstanceId string, :AllowedAccessControlHierarchyGroupId string, :Applications [:seq-of {:Namespace string, :ApplicationPermissions [:seq-of string]}], :Permissions [:seq-of string], :AllowedAccessControlTags [:map-of string string], :SecurityProfileName string, :TagRestrictedResources [:seq-of string], :Description string}, :required [:SecurityProfileName :InstanceId], :response {:SecurityProfileId string, :SecurityProfileArn string}}, :ListSecurityKeys {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:SecurityKeys [:seq-of {:AssociationId string, :Key string, :CreationTime timestamp}], :NextToken string}}, :SearchQueues {:documentation "Searches queues in an Amazon Connect instance, with optional filtering.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:TagFilter {:OrConditions [:seq-of [:seq-of {:TagKey string, :TagValue string}]], :AndConditions [:seq-of {:TagKey string, :TagValue string}], :TagCondition {:TagKey string, :TagValue string}}}, :SearchCriteria shape/QueueSearchCriteria}, :required [:InstanceId], :response {:Queues [:seq-of {:QueueArn string, :LastModifiedTime timestamp, :QueueId string, :Tags [:map-of string string], :MaxContacts integer, :OutboundCallerConfig {:OutboundCallerIdName string, :OutboundCallerIdNumberId string, :OutboundFlowId string}, :LastModifiedRegion string, :Name string, :Description string, :HoursOfOperationId string, :Status [:one-of ["ENABLED" "DISABLED"]]}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/QueueSearchCriteria {:OrConditions [:seq-of shape/QueueSearchCriteria], :AndConditions [:seq-of shape/QueueSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}, :QueueTypeCondition [:one-of ["STANDARD"]]}}}, :DisassociateInstanceStorageConfig {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
", :request {:InstanceId string, :AssociationId string, :ResourceType [:one-of ["CHAT_TRANSCRIPTS" "CALL_RECORDINGS" "SCHEDULED_REPORTS" "MEDIA_STREAMS" "CONTACT_TRACE_RECORDS" "AGENT_EVENTS" "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" "ATTACHMENTS" "CONTACT_EVALUATIONS" "SCREEN_RECORDINGS" "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS" "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS"]]}, :required [:InstanceId :AssociationId :ResourceType]}, :DescribeInstanceStorageConfig {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
", :request {:InstanceId string, :AssociationId string, :ResourceType [:one-of ["CHAT_TRANSCRIPTS" "CALL_RECORDINGS" "SCHEDULED_REPORTS" "MEDIA_STREAMS" "CONTACT_TRACE_RECORDS" "AGENT_EVENTS" "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" "ATTACHMENTS" "CONTACT_EVALUATIONS" "SCREEN_RECORDINGS" "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS" "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS"]]}, :required [:InstanceId :AssociationId :ResourceType], :response {:StorageConfig {:AssociationId string, :StorageType [:one-of ["S3" "KINESIS_VIDEO_STREAM" "KINESIS_STREAM" "KINESIS_FIREHOSE"]], :S3Config {:BucketName string, :BucketPrefix string, :EncryptionConfig {:EncryptionType [:one-of ["KMS"]], :KeyId string}}, :KinesisVideoStreamConfig {:Prefix string, :RetentionPeriodHours integer, :EncryptionConfig {:EncryptionType [:one-of ["KMS"]], :KeyId string}}, :KinesisStreamConfig {:StreamArn string}, :KinesisFirehoseConfig {:FirehoseArn string}}}}, :DeleteUseCase {:documentation "Deletes a use case from an integration association.
", :request {:InstanceId string, :IntegrationAssociationId string, :UseCaseId string}, :required [:InstanceId :IntegrationAssociationId :UseCaseId]}, :DescribeSecurityProfile {:documentation "Gets basic information about the security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", :request {:SecurityProfileId string, :InstanceId string}, :required [:SecurityProfileId :InstanceId], :response {:SecurityProfile {:OrganizationResourceId string, :HierarchyRestrictedResources [:seq-of string], :LastModifiedTime timestamp, :Id string, :Tags [:map-of string string], :AllowedAccessControlHierarchyGroupId string, :AllowedAccessControlTags [:map-of string string], :SecurityProfileName string, :TagRestrictedResources [:seq-of string], :Arn string, :LastModifiedRegion string, :Description string}}}, :ListSecurityProfiles {:documentation "Provides 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 Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:SecurityProfileSummaryList [:seq-of {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string}}, :UpdateUserProficiencies {:documentation "Updates the properties associated with the proficiencies of a user.
", :request {:InstanceId string, :UserId string, :UserProficiencies [:seq-of {:AttributeName string, :AttributeValue string, :Level float}]}, :required [:InstanceId :UserId :UserProficiencies]}, :CreateUserHierarchyGroup {:documentation "Creates a new user hierarchy group.
", :request {:Name string, :ParentGroupId string, :InstanceId string, :Tags [:map-of string string]}, :required [:Name :InstanceId], :response {:HierarchyGroupId string, :HierarchyGroupArn string}}, :DescribeView {:documentation "Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED
needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED
, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST
. If it is not supplied, then $LATEST
is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.
", :request {:InstanceId string, :ViewId string}, :required [:InstanceId :ViewId], :response {:View {:VersionDescription string, :LastModifiedTime timestamp, :ViewContentSha256 string, :Id string, :Tags [:map-of string string], :Arn string, :Name string, :Description string, :Type [:one-of ["CUSTOMER_MANAGED" "AWS_MANAGED"]], :CreatedTime timestamp, :Version integer, :Content {:InputSchema string, :Template string, :Actions [:seq-of string]}, :Status [:one-of ["PUBLISHED" "SAVED"]]}}}, :PutUserStatus {:documentation "Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
", :request {:UserId string, :InstanceId string, :AgentStatusId string}, :required [:UserId :InstanceId :AgentStatusId]}, :ListViews {:documentation "Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
", :request {:InstanceId string, :Type [:one-of ["CUSTOMER_MANAGED" "AWS_MANAGED"]], :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:ViewsSummaryList [:seq-of {:Id string, :Arn string, :Name string, :Type [:one-of ["CUSTOMER_MANAGED" "AWS_MANAGED"]], :Status [:one-of ["PUBLISHED" "SAVED"]], :Description string}], :NextToken string}}, :CreateUser {:documentation "Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo parameters are required in some situations. For example, Email
is required if you are using SAML for identity management. FirstName
and LastName
are required if you are using Amazon Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
", :request {:IdentityInfo {:FirstName string, :LastName string, :Email string, :SecondaryEmail string, :Mobile string}, :SecurityProfileIds [:seq-of string], :Tags [:map-of string string], :InstanceId string, :DirectoryUserId string, :Password string, :RoutingProfileId string, :PhoneConfig {:PhoneType [:one-of ["SOFT_PHONE" "DESK_PHONE"]], :AutoAccept boolean, :AfterContactWorkTimeLimit integer, :DeskPhoneNumber string}, :Username string, :HierarchyGroupId string}, :required [:Username :PhoneConfig :SecurityProfileIds :RoutingProfileId :InstanceId], :response {:UserId string, :UserArn string}}, :TagContact {:documentation "Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
", :request {:ContactId string, :InstanceId string, :Tags [:map-of string string]}, :required [:ContactId :InstanceId :Tags]}, :ListApprovedOrigins {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:Origins [:seq-of string], :NextToken string}}, :UpdateUserIdentityInfo {:documentation "Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo
. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
", :request {:IdentityInfo {:FirstName string, :LastName string, :Email string, :SecondaryEmail string, :Mobile string}, :UserId string, :InstanceId string}, :required [:IdentityInfo :UserId :InstanceId]}, :UpdateParticipantRoleConfig {:documentation "Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
-
Customer idle timeout
-
Customer auto-disconnect timeout
-
Agent idle timeout
-
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
", :request {:InstanceId string, :ContactId string, :ChannelConfiguration {:Chat {:ParticipantTimerConfigList [:seq-of {:ParticipantRole [:one-of ["CUSTOMER" "AGENT"]], :TimerType [:one-of ["IDLE" "DISCONNECT_NONCUSTOMER"]], :TimerValue {:ParticipantTimerAction [:one-of ["Unset"]], :ParticipantTimerDurationInMinutes integer}}]}}}, :required [:InstanceId :ContactId :ChannelConfiguration]}, :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, :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string}}, :UpdateRule {:documentation "Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
", :request {:RuleId string, :InstanceId string, :Name string, :Function string, :Actions [:seq-of {:CreateCaseAction {:Fields [:seq-of {:Id string, :Value {:BooleanValue boolean, :DoubleValue double, :EmptyValue {}, :StringValue string}}], :TemplateId string}, :ActionType [:one-of ["CREATE_TASK" "ASSIGN_CONTACT_CATEGORY" "GENERATE_EVENTBRIDGE_EVENT" "SEND_NOTIFICATION" "CREATE_CASE" "UPDATE_CASE" "END_ASSOCIATED_TASKS" "SUBMIT_AUTO_EVALUATION"]], :SubmitAutoEvaluationAction {:EvaluationFormId string}, :EndAssociatedTasksAction {}, :UpdateCaseAction {:Fields [:seq-of {:Id string, :Value {:BooleanValue boolean, :DoubleValue double, :EmptyValue {}, :StringValue string}}]}, :EventBridgeAction {:Name string}, :TaskAction {:Name string, :Description string, :ContactFlowId string, :References [:map-of string {:Value string, :Type [:one-of ["URL" "ATTACHMENT" "NUMBER" "STRING" "DATE" "EMAIL"]]}]}, :AssignContactCategoryAction {}, :SendNotificationAction {:DeliveryMethod [:one-of ["EMAIL"]], :Subject string, :Content string, :ContentType [:one-of ["PLAIN_TEXT"]], :Recipient {:UserTags [:map-of string string], :UserIds [:seq-of string]}}}], :PublishStatus [:one-of ["DRAFT" "PUBLISHED"]]}, :required [:RuleId :InstanceId :Name :Function :Actions :PublishStatus]}, :UpdateUserHierarchy {:documentation "Assigns the specified hierarchy group to the specified user.
", :request {:HierarchyGroupId string, :UserId string, :InstanceId string}, :required [:UserId :InstanceId]}, :CreateQueue {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
-
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
-
Only use the phone number ARN format that doesn't contain instance
in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
-
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
", :request {:InstanceId string, :Name string, :Description string, :OutboundCallerConfig {:OutboundCallerIdName string, :OutboundCallerIdNumberId string, :OutboundFlowId string}, :HoursOfOperationId string, :MaxContacts integer, :QuickConnectIds [:seq-of string], :Tags [:map-of string string]}, :required [:InstanceId :Name :HoursOfOperationId], :response {:QueueArn string, :QueueId string}}, :UpdateTrafficDistribution {:documentation "Updates the traffic distribution for a given traffic distribution group.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.
", :request {:Id string, :TelephonyConfig {:Distributions [:seq-of {:Region string, :Percentage integer}]}, :SignInConfig {:Distributions [:seq-of {:Region string, :Enabled boolean}]}, :AgentConfig {:Distributions [:seq-of {:Region string, :Percentage integer}]}}, :required [:Id]}, :DescribeUser {:documentation "Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
", :request {:UserId string, :InstanceId string}, :required [:UserId :InstanceId], :response {:User {:LastModifiedTime timestamp, :IdentityInfo {:FirstName string, :LastName string, :Email string, :SecondaryEmail string, :Mobile string}, :SecurityProfileIds [:seq-of string], :Id string, :Tags [:map-of string string], :DirectoryUserId string, :RoutingProfileId string, :Arn string, :LastModifiedRegion string, :PhoneConfig {:PhoneType [:one-of ["SOFT_PHONE" "DESK_PHONE"]], :AutoAccept boolean, :AfterContactWorkTimeLimit integer, :DeskPhoneNumber string}, :Username string, :HierarchyGroupId string}}}, :DescribeAuthenticationProfile {:documentation "This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
", :request {:AuthenticationProfileId string, :InstanceId string}, :required [:AuthenticationProfileId :InstanceId], :response {:AuthenticationProfile {:LastModifiedTime timestamp, :BlockedIps [:seq-of string], :AllowedIps [:seq-of string], :Id string, :IsDefault boolean, :PeriodicSessionDuration integer, :MaxSessionDuration integer, :Arn string, :LastModifiedRegion string, :Name string, :Description string, :CreatedTime timestamp}}}, :SearchQuickConnects {:documentation "Searches quick connects in an Amazon Connect instance, with optional filtering.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:TagFilter {:OrConditions [:seq-of [:seq-of {:TagKey string, :TagValue string}]], :AndConditions [:seq-of {:TagKey string, :TagValue string}], :TagCondition {:TagKey string, :TagValue string}}}, :SearchCriteria shape/QuickConnectSearchCriteria}, :required [:InstanceId], :response {:QuickConnects [:seq-of {:QuickConnectARN string, :QuickConnectId string, :Name string, :Description string, :QuickConnectConfig {:QuickConnectType [:one-of ["USER" "QUEUE" "PHONE_NUMBER"]], :UserConfig {:UserId string, :ContactFlowId string}, :QueueConfig {:QueueId string, :ContactFlowId string}, :PhoneConfig {:PhoneNumber string}}, :Tags [:map-of string string], :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/QuickConnectSearchCriteria {:OrConditions [:seq-of shape/QuickConnectSearchCriteria], :AndConditions [:seq-of shape/QuickConnectSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}}, :ListUserProficiencies {:documentation "Lists proficiencies associated with a user.
", :request {:InstanceId string, :UserId string, :NextToken string, :MaxResults integer}, :required [:InstanceId :UserId], :response {:NextToken string, :UserProficiencyList [:seq-of {:AttributeName string, :AttributeValue string, :Level float}], :LastModifiedTime timestamp, :LastModifiedRegion string}}, :GetFederationToken {:documentation "Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
", :request {:InstanceId string}, :required [:InstanceId], :response {:Credentials {:AccessToken string, :AccessTokenExpiration timestamp, :RefreshToken string, :RefreshTokenExpiration timestamp}, :SignInUrl string, :UserArn string, :UserId string}}, :DeleteTaskTemplate {:documentation "Deletes the task template.
", :request {:InstanceId string, :TaskTemplateId string}, :required [:InstanceId :TaskTemplateId]}, :ListPrompts {:documentation "Provides information about the prompts for the specified Amazon Connect instance.
", :request {:InstanceId string, :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:PromptSummaryList [:seq-of {:Id string, :Arn string, :Name string, :LastModifiedTime timestamp, :LastModifiedRegion string}], :NextToken string}}, :UpdateQueueHoursOfOperation {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
", :request {:InstanceId string, :QueueId string, :HoursOfOperationId string}, :required [:InstanceId :QueueId :HoursOfOperationId]}, :DisassociateLambdaFunction {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
", :request {:InstanceId string, :FunctionArn string}, :required [:InstanceId :FunctionArn]}, :StartChatContact {:documentation "Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
-
API rate limit is exceeded. API TPS throttling returns a TooManyRequests
exception.
-
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
", :request {:SupportedMessagingContentTypes [:seq-of string], :SegmentAttributes [:map-of string {:ValueString string}], :InitialMessage {:ContentType string, :Content string}, :InstanceId string, :ContactFlowId string, :ParticipantDetails {:DisplayName string}, :ChatDurationInMinutes integer, :RelatedContactId string, :PersistentChat {:RehydrationType [:one-of ["ENTIRE_PAST_SESSION" "FROM_SEGMENT"]], :SourceContactId string}, :ClientToken string, :Attributes [:map-of string string]}, :required [:InstanceId :ContactFlowId :ParticipantDetails], :response {:ContactId string, :ParticipantId string, :ParticipantToken string, :ContinuedFromContactId string}}, :SearchResourceTags {:documentation "Searches tags used in an Amazon Connect instance using optional search criteria.
", :request {:InstanceId string, :ResourceTypes [:seq-of string], :NextToken string, :MaxResults integer, :SearchCriteria {:TagSearchCondition {:tagKey string, :tagValue string, :tagKeyComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]], :tagValueComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}}}, :required [:InstanceId], :response {:Tags [:seq-of {:key string, :value string}], :NextToken string}}, :BatchPutContact {:documentation " Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
", :request {:ClientToken string, :InstanceId string, :ContactDataRequestList [:seq-of {:SystemEndpoint {:Type [:one-of ["TELEPHONE_NUMBER" "VOIP" "CONTACT_FLOW"]], :Address string}, :CustomerEndpoint {:Type [:one-of ["TELEPHONE_NUMBER" "VOIP" "CONTACT_FLOW"]], :Address string}, :RequestIdentifier string, :QueueId string, :Attributes [:map-of string string], :Campaign {:CampaignId string}}]}, :required [:InstanceId :ContactDataRequestList], :response {:SuccessfulRequestList [:seq-of {:RequestIdentifier string, :ContactId string}], :FailedRequestList [:seq-of {:RequestIdentifier string, :FailureReasonCode [:one-of ["INVALID_ATTRIBUTE_KEY" "INVALID_CUSTOMER_ENDPOINT" "INVALID_SYSTEM_ENDPOINT" "INVALID_QUEUE" "MISSING_CAMPAIGN" "MISSING_CUSTOMER_ENDPOINT" "MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT" "REQUEST_THROTTLED" "IDEMPOTENCY_EXCEPTION" "INTERNAL_ERROR"]], :FailureReasonMessage string}]}}, :ListTrafficDistributionGroups {:documentation "Lists traffic distribution groups.
", :request {:MaxResults integer, :NextToken string, :InstanceId string}, :response {:NextToken string, :TrafficDistributionGroupSummaryList [:seq-of {:Id string, :Arn string, :Name string, :InstanceArn string, :Status [:one-of ["CREATION_IN_PROGRESS" "ACTIVE" "CREATION_FAILED" "PENDING_DELETION" "DELETION_FAILED" "UPDATE_IN_PROGRESS"]], :IsDefault boolean}]}}, :CreateQuickConnect {:documentation "Creates a quick connect for the specified Amazon Connect instance.
", :request {:InstanceId string, :Name string, :Description string, :QuickConnectConfig {:QuickConnectType [:one-of ["USER" "QUEUE" "PHONE_NUMBER"]], :UserConfig {:UserId string, :ContactFlowId string}, :QueueConfig {:QueueId string, :ContactFlowId string}, :PhoneConfig {:PhoneNumber string}}, :Tags [:map-of string string]}, :required [:InstanceId :Name :QuickConnectConfig], :response {:QuickConnectARN string, :QuickConnectId string}}, :UpdateSecurityProfile {:documentation "Updates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", :request {:HierarchyRestrictedResources [:seq-of string], :SecurityProfileId string, :InstanceId string, :AllowedAccessControlHierarchyGroupId string, :Applications [:seq-of {:Namespace string, :ApplicationPermissions [:seq-of string]}], :Permissions [:seq-of string], :AllowedAccessControlTags [:map-of string string], :TagRestrictedResources [:seq-of string], :Description string}, :required [:SecurityProfileId :InstanceId]}, :UpdatePhoneNumberMetadata {:documentation "Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
", :request {:PhoneNumberId string, :PhoneNumberDescription string, :ClientToken string}, :required [:PhoneNumberId]}, :DeleteView {:documentation "Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
", :request {:InstanceId string, :ViewId string}, :required [:InstanceId :ViewId]}, :ResumeContactRecording {:documentation "When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
", :request {:InstanceId string, :ContactId string, :InitialContactId string}, :required [:InstanceId :ContactId :InitialContactId]}, :UpdateContactFlowName {:documentation "The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
", :request {:InstanceId string, :ContactFlowId string, :Name string, :Description string}, :required [:InstanceId :ContactFlowId]}, :StopContactStreaming {:documentation " Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
", :request {:InstanceId string, :ContactId string, :StreamingId string}, :required [:InstanceId :ContactId :StreamingId]}, :DeleteAttachedFile {:documentation "Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
", :request {:InstanceId string, :FileId string, :AssociatedResourceArn string}, :required [:InstanceId :FileId :AssociatedResourceArn]}, :ListPhoneNumbers {:documentation "Provides 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 the Amazon Connect Administrator Guide.
-
We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN
, SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE
or DID
.
-
The phone number Arn
value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException
. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.
", :request {:InstanceId string, :PhoneNumberTypes [:seq-of [:one-of ["TOLL_FREE" "DID" "UIFN" "SHARED" "THIRD_PARTY_TF" "THIRD_PARTY_DID" "SHORT_CODE"]]], :PhoneNumberCountryCodes [:seq-of [:one-of ["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"]]], :NextToken string, :MaxResults integer}, :required [:InstanceId], :response {:PhoneNumberSummaryList [:seq-of {:Id string, :Arn string, :PhoneNumber string, :PhoneNumberType [:one-of ["TOLL_FREE" "DID" "UIFN" "SHARED" "THIRD_PARTY_TF" "THIRD_PARTY_DID" "SHORT_CODE"]], :PhoneNumberCountryCode [:one-of ["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"]]}], :NextToken string}}, :AssociateRoutingProfileQueues {:documentation "Associates a set of queues with a routing profile.
", :request {:InstanceId string, :RoutingProfileId string, :QueueConfigs [:seq-of {:QueueReference {:QueueId string, :Channel [:one-of ["VOICE" "CHAT" "TASK"]]}, :Priority integer, :Delay integer}]}, :required [:InstanceId :RoutingProfileId :QueueConfigs]}, :DescribeContact {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
", :request {:InstanceId string, :ContactId string}, :required [:InstanceId :ContactId], :response {:Contact {:InitialContactId string, :QueueInfo {:Id string, :EnqueueTimestamp timestamp}, :PreviousContactId string, :SegmentAttributes [:map-of string {:ValueString string}], :Campaign {:CampaignId string}, :QueuePriority long, :TotalPauseDurationInSeconds integer, :LastResumedTimestamp timestamp, :AgentInfo {:Id string, :ConnectedToAgentTimestamp timestamp, :AgentPauseDurationInSeconds integer, :HierarchyGroups {:Level1 {:Arn string}, :Level2 {:Arn string}, :Level3 {:Arn string}, :Level4 {:Arn string}, :Level5 {:Arn string}}, :DeviceInfo {:PlatformName string, :PlatformVersion string, :OperatingSystem string}, :Capabilities {:Video [:one-of ["SEND"]]}}, :Id string, :AnsweringMachineDetectionStatus [:one-of ["ANSWERED" "UNDETECTED" "ERROR" "HUMAN_ANSWERED" "SIT_TONE_DETECTED" "SIT_TONE_BUSY" "SIT_TONE_INVALID_NUMBER" "FAX_MACHINE_DETECTED" "VOICEMAIL_BEEP" "VOICEMAIL_NO_BEEP" "AMD_UNRESOLVED" "AMD_UNANSWERED" "AMD_ERROR" "AMD_NOT_APPLICABLE"]], :Tags [:map-of string string], :QueueTimeAdjustmentSeconds integer, :Channel [:one-of ["VOICE" "CHAT" "TASK"]], :DisconnectTimestamp timestamp, :RoutingCriteria {:Steps [:seq-of {:Expiry {:DurationInSeconds integer, :ExpiryTimestamp timestamp}, :Expression shape/Expression, :Status [:one-of ["ACTIVE" "INACTIVE" "JOINED" "EXPIRED"]]}], :ActivationTimestamp timestamp, :Index integer}, :CustomerVoiceActivity {:GreetingStartTimestamp timestamp, :GreetingEndTimestamp timestamp}, :LastUpdateTimestamp timestamp, :ConnectedToSystemTimestamp timestamp, :TotalPauseCount integer, :Customer {:DeviceInfo {:PlatformName string, :PlatformVersion string, :OperatingSystem string}, :Capabilities {:Video [:one-of ["SEND"]]}}, :LastPausedTimestamp timestamp, :RelatedContactId string, :ScheduledTimestamp timestamp, :DisconnectDetails {:PotentialDisconnectIssue string}, :InitiationMethod [:one-of ["INBOUND" "OUTBOUND" "TRANSFER" "QUEUE_TRANSFER" "CALLBACK" "API" "DISCONNECT" "MONITOR" "EXTERNAL_OUTBOUND"]], :Arn string, :Name string, :Description string, :QualityMetrics {:Agent {:Audio {:QualityScore float, :PotentialQualityIssues [:seq-of string]}}, :Customer {:Audio {:QualityScore float, :PotentialQualityIssues [:seq-of string]}}}, :WisdomInfo {:SessionArn string}, :InitiationTimestamp timestamp}}, :refs {shape/Expression {:AttributeCondition {:Name string, :Value string, :ProficiencyLevel float, :MatchCriteria {:AgentsCriteria {:AgentIds [:seq-of string]}}, :ComparisonOperator string}, :AndExpression [:seq-of shape/Expression], :OrExpression [:seq-of shape/Expression]}}}, :AssociateQueueQuickConnects {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
", :request {:InstanceId string, :QueueId string, :QuickConnectIds [:seq-of string]}, :required [:InstanceId :QueueId :QuickConnectIds]}, :SearchContactFlows {:documentation "Searches the contact flows in an Amazon Connect instance, with optional filtering.
", :request {:InstanceId string, :NextToken string, :MaxResults integer, :SearchFilter {:TagFilter {:OrConditions [:seq-of [:seq-of {:TagKey string, :TagValue string}]], :AndConditions [:seq-of {:TagKey string, :TagValue string}], :TagCondition {:TagKey string, :TagValue string}}}, :SearchCriteria shape/ContactFlowSearchCriteria}, :required [:InstanceId], :response {:ContactFlows [:seq-of {:Id string, :Tags [:map-of string string], :Arn string, :Name string, :Description string, :Type [:one-of ["CONTACT_FLOW" "CUSTOMER_QUEUE" "CUSTOMER_HOLD" "CUSTOMER_WHISPER" "AGENT_HOLD" "AGENT_WHISPER" "OUTBOUND_WHISPER" "AGENT_TRANSFER" "QUEUE_TRANSFER"]], :State [:one-of ["ACTIVE" "ARCHIVED"]], :Content string, :Status [:one-of ["PUBLISHED" "SAVED"]]}], :NextToken string, :ApproximateTotalCount long}, :refs {shape/ContactFlowSearchCriteria {:OrConditions [:seq-of shape/ContactFlowSearchCriteria], :AndConditions [:seq-of shape/ContactFlowSearchCriteria], :StringCondition {:FieldName string, :Value string, :ComparisonType [:one-of ["STARTS_WITH" "CONTAINS" "EXACT"]]}, :TypeCondition [:one-of ["CONTACT_FLOW" "CUSTOMER_QUEUE" "CUSTOMER_HOLD" "CUSTOMER_WHISPER" "AGENT_HOLD" "AGENT_WHISPER" "OUTBOUND_WHISPER" "AGENT_TRANSFER" "QUEUE_TRANSFER"]], :StateCondition [:one-of ["ACTIVE" "ARCHIVED"]], :StatusCondition [:one-of ["PUBLISHED" "SAVED"]]}}}, :UpdateContactFlowMetadata {:documentation "Updates metadata about specified flow.
", :request {:InstanceId string, :ContactFlowId string, :Name string, :Description string, :ContactFlowState [:one-of ["ACTIVE" "ARCHIVED"]]}, :required [:InstanceId :ContactFlowId]}, :UpdateQueueOutboundCallerConfig {:documentation "This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
-
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
-
Only use the phone number ARN format that doesn't contain instance
in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
-
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
", :request {:InstanceId string, :QueueId string, :OutboundCallerConfig {:OutboundCallerIdName string, :OutboundCallerIdNumberId string, :OutboundFlowId string}}, :required [:InstanceId :QueueId :OutboundCallerConfig]}}