aws-sdk
Version:
AWS SDK for JavaScript
2,145 lines • 297 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2017-08-08",
"endpointPrefix": "connect",
"jsonVersion": "1.1",
"protocol": "rest-json",
"protocols": [
"rest-json"
],
"serviceAbbreviation": "Amazon Connect",
"serviceFullName": "Amazon Connect Service",
"serviceId": "Connect",
"signatureVersion": "v4",
"signingName": "connect",
"uid": "connect-2017-08-08",
"auth": [
"aws.auth#sigv4"
]
},
"operations": {
"ActivateEvaluationForm": {
"http": {
"requestUri": "/evaluation-forms/{InstanceId}/{EvaluationFormId}/activate"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"EvaluationFormId",
"EvaluationFormVersion"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"EvaluationFormId": {
"location": "uri",
"locationName": "EvaluationFormId"
},
"EvaluationFormVersion": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"required": [
"EvaluationFormId",
"EvaluationFormArn",
"EvaluationFormVersion"
],
"members": {
"EvaluationFormId": {},
"EvaluationFormArn": {},
"EvaluationFormVersion": {
"type": "integer"
}
}
}
},
"AssociateAnalyticsDataSet": {
"http": {
"method": "PUT",
"requestUri": "/analytics-data/instance/{InstanceId}/association"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"DataSetId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"DataSetId": {},
"TargetAccountId": {}
}
},
"output": {
"type": "structure",
"members": {
"DataSetId": {},
"TargetAccountId": {},
"ResourceShareId": {},
"ResourceShareArn": {}
}
}
},
"AssociateApprovedOrigin": {
"http": {
"method": "PUT",
"requestUri": "/instance/{InstanceId}/approved-origin"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Origin"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Origin": {}
}
}
},
"AssociateBot": {
"http": {
"method": "PUT",
"requestUri": "/instance/{InstanceId}/bot"
},
"input": {
"type": "structure",
"required": [
"InstanceId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"LexBot": {
"shape": "Sf"
},
"LexV2Bot": {
"shape": "Si"
}
}
}
},
"AssociateDefaultVocabulary": {
"http": {
"method": "PUT",
"requestUri": "/default-vocabulary/{InstanceId}/{LanguageCode}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"LanguageCode"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"LanguageCode": {
"location": "uri",
"locationName": "LanguageCode"
},
"VocabularyId": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AssociateFlow": {
"http": {
"method": "PUT",
"requestUri": "/flow-associations/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"ResourceId",
"FlowId",
"ResourceType"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"ResourceId": {},
"FlowId": {},
"ResourceType": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AssociateInstanceStorageConfig": {
"http": {
"method": "PUT",
"requestUri": "/instance/{InstanceId}/storage-config"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"ResourceType",
"StorageConfig"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"ResourceType": {},
"StorageConfig": {
"shape": "St"
}
}
},
"output": {
"type": "structure",
"members": {
"AssociationId": {}
}
}
},
"AssociateLambdaFunction": {
"http": {
"method": "PUT",
"requestUri": "/instance/{InstanceId}/lambda-function"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"FunctionArn"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"FunctionArn": {}
}
}
},
"AssociateLexBot": {
"http": {
"method": "PUT",
"requestUri": "/instance/{InstanceId}/lex-bot"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"LexBot"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"LexBot": {
"shape": "Sf"
}
}
}
},
"AssociatePhoneNumberContactFlow": {
"http": {
"method": "PUT",
"requestUri": "/phone-number/{PhoneNumberId}/contact-flow"
},
"input": {
"type": "structure",
"required": [
"PhoneNumberId",
"InstanceId",
"ContactFlowId"
],
"members": {
"PhoneNumberId": {
"location": "uri",
"locationName": "PhoneNumberId"
},
"InstanceId": {},
"ContactFlowId": {}
}
}
},
"AssociateQueueQuickConnects": {
"http": {
"requestUri": "/queues/{InstanceId}/{QueueId}/associate-quick-connects"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"QueueId",
"QuickConnectIds"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"QueueId": {
"location": "uri",
"locationName": "QueueId"
},
"QuickConnectIds": {
"shape": "S1f"
}
}
}
},
"AssociateRoutingProfileQueues": {
"http": {
"requestUri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"RoutingProfileId",
"QueueConfigs"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"RoutingProfileId": {
"location": "uri",
"locationName": "RoutingProfileId"
},
"QueueConfigs": {
"shape": "S1j"
}
}
}
},
"AssociateSecurityKey": {
"http": {
"method": "PUT",
"requestUri": "/instance/{InstanceId}/security-key"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Key"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Key": {}
}
},
"output": {
"type": "structure",
"members": {
"AssociationId": {}
}
}
},
"AssociateTrafficDistributionGroupUser": {
"http": {
"method": "PUT",
"requestUri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user"
},
"input": {
"type": "structure",
"required": [
"TrafficDistributionGroupId",
"UserId",
"InstanceId"
],
"members": {
"TrafficDistributionGroupId": {
"location": "uri",
"locationName": "TrafficDistributionGroupId"
},
"UserId": {},
"InstanceId": {}
}
},
"output": {
"type": "structure",
"members": {}
},
"idempotent": true
},
"AssociateUserProficiencies": {
"http": {
"requestUri": "/users/{InstanceId}/{UserId}/associate-proficiencies"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"UserId",
"UserProficiencies"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"UserId": {
"location": "uri",
"locationName": "UserId"
},
"UserProficiencies": {
"shape": "S1x"
}
}
}
},
"BatchAssociateAnalyticsDataSet": {
"http": {
"method": "PUT",
"requestUri": "/analytics-data/instance/{InstanceId}/associations"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"DataSetIds"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"DataSetIds": {
"shape": "S23"
},
"TargetAccountId": {}
}
},
"output": {
"type": "structure",
"members": {
"Created": {
"shape": "S25"
},
"Errors": {
"shape": "S27"
}
}
}
},
"BatchDisassociateAnalyticsDataSet": {
"http": {
"requestUri": "/analytics-data/instance/{InstanceId}/associations"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"DataSetIds"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"DataSetIds": {
"shape": "S23"
},
"TargetAccountId": {}
}
},
"output": {
"type": "structure",
"members": {
"Deleted": {
"shape": "S23"
},
"Errors": {
"shape": "S27"
}
}
}
},
"BatchGetAttachedFileMetadata": {
"http": {
"requestUri": "/attached-files/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"FileIds",
"InstanceId",
"AssociatedResourceArn"
],
"members": {
"FileIds": {
"type": "list",
"member": {}
},
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"AssociatedResourceArn": {
"location": "querystring",
"locationName": "associatedResourceArn"
}
}
},
"output": {
"type": "structure",
"members": {
"Files": {
"type": "list",
"member": {
"type": "structure",
"required": [
"CreationTime",
"FileArn",
"FileId",
"FileName",
"FileSizeInBytes",
"FileStatus"
],
"members": {
"CreationTime": {},
"FileArn": {},
"FileId": {},
"FileName": {},
"FileSizeInBytes": {
"type": "long"
},
"FileStatus": {},
"CreatedBy": {
"shape": "S2l"
},
"FileUseCaseType": {},
"AssociatedResourceArn": {},
"Tags": {
"shape": "S2n"
}
}
}
},
"Errors": {
"type": "list",
"member": {
"type": "structure",
"members": {
"ErrorCode": {},
"ErrorMessage": {},
"FileId": {}
}
}
}
}
}
},
"BatchGetFlowAssociation": {
"http": {
"requestUri": "/flow-associations-batch/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"ResourceIds"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"ResourceIds": {
"type": "list",
"member": {}
},
"ResourceType": {}
}
},
"output": {
"type": "structure",
"members": {
"FlowAssociationSummaryList": {
"shape": "S2y"
}
}
}
},
"BatchPutContact": {
"http": {
"method": "PUT",
"requestUri": "/contact/batch/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"ContactDataRequestList"
],
"members": {
"ClientToken": {
"idempotencyToken": true
},
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"ContactDataRequestList": {
"type": "list",
"member": {
"type": "structure",
"members": {
"SystemEndpoint": {
"shape": "S34"
},
"CustomerEndpoint": {
"shape": "S34"
},
"RequestIdentifier": {},
"QueueId": {},
"Attributes": {
"shape": "S38"
},
"Campaign": {
"shape": "S3b"
}
}
}
}
}
},
"output": {
"type": "structure",
"members": {
"SuccessfulRequestList": {
"type": "list",
"member": {
"type": "structure",
"members": {
"RequestIdentifier": {},
"ContactId": {}
}
}
},
"FailedRequestList": {
"type": "list",
"member": {
"type": "structure",
"members": {
"RequestIdentifier": {},
"FailureReasonCode": {},
"FailureReasonMessage": {}
}
}
}
}
},
"idempotent": true
},
"ClaimPhoneNumber": {
"http": {
"requestUri": "/phone-number/claim"
},
"input": {
"type": "structure",
"required": [
"PhoneNumber"
],
"members": {
"TargetArn": {},
"InstanceId": {},
"PhoneNumber": {},
"PhoneNumberDescription": {},
"Tags": {
"shape": "S2n"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"PhoneNumberId": {},
"PhoneNumberArn": {}
}
}
},
"CompleteAttachedFileUpload": {
"http": {
"requestUri": "/attached-files/{InstanceId}/{FileId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"FileId",
"AssociatedResourceArn"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"FileId": {
"location": "uri",
"locationName": "FileId"
},
"AssociatedResourceArn": {
"location": "querystring",
"locationName": "associatedResourceArn"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CreateAgentStatus": {
"http": {
"method": "PUT",
"requestUri": "/agent-status/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"State"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Description": {},
"State": {},
"DisplayOrder": {
"type": "integer"
},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"AgentStatusARN": {},
"AgentStatusId": {}
}
}
},
"CreateContactFlow": {
"http": {
"method": "PUT",
"requestUri": "/contact-flows/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"Type",
"Content"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Type": {},
"Description": {},
"Content": {},
"Status": {},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"ContactFlowId": {},
"ContactFlowArn": {}
}
}
},
"CreateContactFlowModule": {
"http": {
"method": "PUT",
"requestUri": "/contact-flow-modules/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"Content"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Description": {},
"Content": {},
"Tags": {
"shape": "S2n"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"Id": {},
"Arn": {}
}
}
},
"CreateEvaluationForm": {
"http": {
"method": "PUT",
"requestUri": "/evaluation-forms/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Title",
"Items"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Title": {},
"Description": {},
"Items": {
"shape": "S4d"
},
"ScoringStrategy": {
"shape": "S58"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"required": [
"EvaluationFormId",
"EvaluationFormArn"
],
"members": {
"EvaluationFormId": {},
"EvaluationFormArn": {}
}
},
"idempotent": true
},
"CreateHoursOfOperation": {
"http": {
"method": "PUT",
"requestUri": "/hours-of-operations/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"TimeZone",
"Config"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Description": {},
"TimeZone": {},
"Config": {
"shape": "S5g"
},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"HoursOfOperationId": {},
"HoursOfOperationArn": {}
}
}
},
"CreateInstance": {
"http": {
"method": "PUT",
"requestUri": "/instance"
},
"input": {
"type": "structure",
"required": [
"IdentityManagementType",
"InboundCallsEnabled",
"OutboundCallsEnabled"
],
"members": {
"ClientToken": {},
"IdentityManagementType": {},
"InstanceAlias": {
"shape": "S5q"
},
"DirectoryId": {},
"InboundCallsEnabled": {
"type": "boolean"
},
"OutboundCallsEnabled": {
"type": "boolean"
},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"Id": {},
"Arn": {}
}
}
},
"CreateIntegrationAssociation": {
"http": {
"method": "PUT",
"requestUri": "/instance/{InstanceId}/integration-associations"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"IntegrationType",
"IntegrationArn"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"IntegrationType": {},
"IntegrationArn": {},
"SourceApplicationUrl": {},
"SourceApplicationName": {},
"SourceType": {},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"IntegrationAssociationId": {},
"IntegrationAssociationArn": {}
}
}
},
"CreateParticipant": {
"http": {
"requestUri": "/contact/create-participant"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"ContactId",
"ParticipantDetails"
],
"members": {
"InstanceId": {},
"ContactId": {},
"ClientToken": {
"idempotencyToken": true
},
"ParticipantDetails": {
"type": "structure",
"members": {
"ParticipantRole": {},
"DisplayName": {}
}
}
}
},
"output": {
"type": "structure",
"members": {
"ParticipantCredentials": {
"type": "structure",
"members": {
"ParticipantToken": {},
"Expiry": {}
}
},
"ParticipantId": {}
}
}
},
"CreatePersistentContactAssociation": {
"http": {
"requestUri": "/contact/persistent-contact-association/{InstanceId}/{InitialContactId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"InitialContactId",
"RehydrationType",
"SourceContactId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"InitialContactId": {
"location": "uri",
"locationName": "InitialContactId"
},
"RehydrationType": {},
"SourceContactId": {},
"ClientToken": {}
}
},
"output": {
"type": "structure",
"members": {
"ContinuedFromContactId": {}
}
}
},
"CreatePredefinedAttribute": {
"http": {
"method": "PUT",
"requestUri": "/predefined-attributes/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"Values"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Values": {
"shape": "S6e"
}
}
}
},
"CreatePrompt": {
"http": {
"method": "PUT",
"requestUri": "/prompts/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"S3Uri"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Description": {},
"S3Uri": {},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"PromptARN": {},
"PromptId": {}
}
}
},
"CreateQueue": {
"http": {
"method": "PUT",
"requestUri": "/queues/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"HoursOfOperationId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Description": {},
"OutboundCallerConfig": {
"shape": "S6n"
},
"HoursOfOperationId": {},
"MaxContacts": {
"type": "integer"
},
"QuickConnectIds": {
"shape": "S1f"
},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"QueueArn": {},
"QueueId": {}
}
}
},
"CreateQuickConnect": {
"http": {
"method": "PUT",
"requestUri": "/quick-connects/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"QuickConnectConfig"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Description": {},
"QuickConnectConfig": {
"shape": "S6u"
},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"QuickConnectARN": {},
"QuickConnectId": {}
}
}
},
"CreateRoutingProfile": {
"http": {
"method": "PUT",
"requestUri": "/routing-profiles/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"Description",
"DefaultOutboundQueueId",
"MediaConcurrencies"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Description": {},
"DefaultOutboundQueueId": {},
"QueueConfigs": {
"shape": "S1j"
},
"MediaConcurrencies": {
"shape": "S73"
},
"Tags": {
"shape": "S2n"
},
"AgentAvailabilityTimer": {}
}
},
"output": {
"type": "structure",
"members": {
"RoutingProfileArn": {},
"RoutingProfileId": {}
}
}
},
"CreateRule": {
"http": {
"requestUri": "/rules/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"TriggerEventSource",
"Function",
"Actions",
"PublishStatus"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"TriggerEventSource": {
"shape": "S7c"
},
"Function": {},
"Actions": {
"shape": "S7f"
},
"PublishStatus": {},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"required": [
"RuleArn",
"RuleId"
],
"members": {
"RuleArn": {},
"RuleId": {}
}
}
},
"CreateSecurityProfile": {
"http": {
"method": "PUT",
"requestUri": "/security-profiles/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"SecurityProfileName",
"InstanceId"
],
"members": {
"SecurityProfileName": {},
"Description": {},
"Permissions": {
"shape": "S8k"
},
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Tags": {
"shape": "S2n"
},
"AllowedAccessControlTags": {
"shape": "S8m"
},
"TagRestrictedResources": {
"shape": "S8p"
},
"Applications": {
"shape": "S8r"
},
"HierarchyRestrictedResources": {
"shape": "S8w"
},
"AllowedAccessControlHierarchyGroupId": {}
}
},
"output": {
"type": "structure",
"members": {
"SecurityProfileId": {},
"SecurityProfileArn": {}
}
}
},
"CreateTaskTemplate": {
"http": {
"method": "PUT",
"requestUri": "/instance/{InstanceId}/task/template"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name",
"Fields"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {},
"Description": {},
"ContactFlowId": {},
"Constraints": {
"shape": "S94"
},
"Defaults": {
"shape": "S9d"
},
"Status": {},
"Fields": {
"shape": "S9i"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"required": [
"Id",
"Arn"
],
"members": {
"Id": {},
"Arn": {}
}
}
},
"CreateTrafficDistributionGroup": {
"http": {
"method": "PUT",
"requestUri": "/traffic-distribution-group"
},
"input": {
"type": "structure",
"required": [
"Name",
"InstanceId"
],
"members": {
"Name": {},
"Description": {},
"InstanceId": {},
"ClientToken": {
"idempotencyToken": true
},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"Id": {},
"Arn": {}
}
}
},
"CreateUseCase": {
"http": {
"method": "PUT",
"requestUri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"IntegrationAssociationId",
"UseCaseType"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"IntegrationAssociationId": {
"location": "uri",
"locationName": "IntegrationAssociationId"
},
"UseCaseType": {},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"UseCaseId": {},
"UseCaseArn": {}
}
}
},
"CreateUser": {
"http": {
"method": "PUT",
"requestUri": "/users/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"Username",
"PhoneConfig",
"SecurityProfileIds",
"RoutingProfileId",
"InstanceId"
],
"members": {
"Username": {},
"Password": {
"type": "string",
"sensitive": true
},
"IdentityInfo": {
"shape": "Sa5"
},
"PhoneConfig": {
"shape": "Sa9"
},
"DirectoryUserId": {},
"SecurityProfileIds": {
"shape": "Sae"
},
"RoutingProfileId": {},
"HierarchyGroupId": {},
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"UserId": {},
"UserArn": {}
}
}
},
"CreateUserHierarchyGroup": {
"http": {
"method": "PUT",
"requestUri": "/user-hierarchy-groups/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"Name",
"InstanceId"
],
"members": {
"Name": {},
"ParentGroupId": {},
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"HierarchyGroupId": {},
"HierarchyGroupArn": {}
}
}
},
"CreateView": {
"http": {
"method": "PUT",
"requestUri": "/views/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Status",
"Content",
"Name"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"ClientToken": {},
"Status": {},
"Content": {
"shape": "San"
},
"Description": {},
"Name": {
"shape": "Sas"
},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"members": {
"View": {
"shape": "Sau"
}
}
},
"idempotent": true
},
"CreateViewVersion": {
"http": {
"method": "PUT",
"requestUri": "/views/{InstanceId}/{ViewId}/versions"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"ViewId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"ViewId": {
"location": "uri",
"locationName": "ViewId"
},
"VersionDescription": {},
"ViewContentSha256": {}
}
},
"output": {
"type": "structure",
"members": {
"View": {
"shape": "Sau"
}
}
},
"idempotent": true
},
"CreateVocabulary": {
"http": {
"requestUri": "/vocabulary/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"VocabularyName",
"LanguageCode",
"Content"
],
"members": {
"ClientToken": {
"idempotencyToken": true
},
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"VocabularyName": {},
"LanguageCode": {},
"Content": {},
"Tags": {
"shape": "S2n"
}
}
},
"output": {
"type": "structure",
"required": [
"VocabularyArn",
"VocabularyId",
"State"
],
"members": {
"VocabularyArn": {},
"VocabularyId": {},
"State": {}
}
}
},
"DeactivateEvaluationForm": {
"http": {
"requestUri": "/evaluation-forms/{InstanceId}/{EvaluationFormId}/deactivate"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"EvaluationFormId",
"EvaluationFormVersion"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"EvaluationFormId": {
"location": "uri",
"locationName": "EvaluationFormId"
},
"EvaluationFormVersion": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"required": [
"EvaluationFormId",
"EvaluationFormArn",
"EvaluationFormVersion"
],
"members": {
"EvaluationFormId": {},
"EvaluationFormArn": {},
"EvaluationFormVersion": {
"type": "integer"
}
}
}
},
"DeleteAttachedFile": {
"http": {
"method": "DELETE",
"requestUri": "/attached-files/{InstanceId}/{FileId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"FileId",
"AssociatedResourceArn"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"FileId": {
"location": "uri",
"locationName": "FileId"
},
"AssociatedResourceArn": {
"location": "querystring",
"locationName": "associatedResourceArn"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteContactEvaluation": {
"http": {
"method": "DELETE",
"requestUri": "/contact-evaluations/{InstanceId}/{EvaluationId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"EvaluationId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"EvaluationId": {
"location": "uri",
"locationName": "EvaluationId"
}
}
},
"idempotent": true
},
"DeleteContactFlow": {
"http": {
"method": "DELETE",
"requestUri": "/contact-flows/{InstanceId}/{ContactFlowId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"ContactFlowId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"ContactFlowId": {
"location": "uri",
"locationName": "ContactFlowId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteContactFlowModule": {
"http": {
"method": "DELETE",
"requestUri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"ContactFlowModuleId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"ContactFlowModuleId": {
"location": "uri",
"locationName": "ContactFlowModuleId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteEvaluationForm": {
"http": {
"method": "DELETE",
"requestUri": "/evaluation-forms/{InstanceId}/{EvaluationFormId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"EvaluationFormId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"EvaluationFormId": {
"location": "uri",
"locationName": "EvaluationFormId"
},
"EvaluationFormVersion": {
"location": "querystring",
"locationName": "version",
"type": "integer"
}
}
},
"idempotent": true
},
"DeleteHoursOfOperation": {
"http": {
"method": "DELETE",
"requestUri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"HoursOfOperationId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"HoursOfOperationId": {
"location": "uri",
"locationName": "HoursOfOperationId"
}
}
}
},
"DeleteInstance": {
"http": {
"method": "DELETE",
"requestUri": "/instance/{InstanceId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
}
}
}
},
"DeleteIntegrationAssociation": {
"http": {
"method": "DELETE",
"requestUri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"IntegrationAssociationId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"IntegrationAssociationId": {
"location": "uri",
"locationName": "IntegrationAssociationId"
}
}
}
},
"DeletePredefinedAttribute": {
"http": {
"method": "DELETE",
"requestUri": "/predefined-attributes/{InstanceId}/{Name}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"Name"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"Name": {
"location": "uri",
"locationName": "Name"
}
}
},
"idempotent": true
},
"DeletePrompt": {
"http": {
"method": "DELETE",
"requestUri": "/prompts/{InstanceId}/{PromptId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"PromptId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"PromptId": {
"location": "uri",
"locationName": "PromptId"
}
}
}
},
"DeleteQueue": {
"http": {
"method": "DELETE",
"requestUri": "/queues/{InstanceId}/{QueueId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"QueueId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"QueueId": {
"location": "uri",
"locationName": "QueueId"
}
}
}
},
"DeleteQuickConnect": {
"http": {
"method": "DELETE",
"requestUri": "/quick-connects/{InstanceId}/{QuickConnectId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"QuickConnectId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"QuickConnectId": {
"location": "uri",
"locationName": "QuickConnectId"
}
}
}
},
"DeleteRoutingProfile": {
"http": {
"method": "DELETE",
"requestUri": "/routing-profiles/{InstanceId}/{RoutingProfileId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"RoutingProfileId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"RoutingProfileId": {
"location": "uri",
"locationName": "RoutingProfileId"
}
}
}
},
"DeleteRule": {
"http": {
"method": "DELETE",
"requestUri": "/rules/{InstanceId}/{RuleId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"RuleId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"RuleId": {
"location": "uri",
"locationName": "RuleId"
}
}
}
},
"DeleteSecurityProfile": {
"http": {
"method": "DELETE",
"requestUri": "/security-profiles/{InstanceId}/{SecurityProfileId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"SecurityProfileId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"SecurityProfileId": {
"location": "uri",
"locationName": "SecurityProfileId"
}
}
}
},
"DeleteTaskTemplate": {
"http": {
"method": "DELETE",
"requestUri": "/instance/{InstanceId}/task/template/{TaskTemplateId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"TaskTemplateId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"TaskTemplateId": {
"location": "uri",
"locationName": "TaskTemplateId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteTrafficDistributionGroup": {
"http": {
"method": "DELETE",
"requestUri": "/traffic-distribution-group/{TrafficDistributionGroupId}"
},
"input": {
"type": "structure",
"required": [
"TrafficDistributionGroupId"
],
"members": {
"TrafficDistributionGroupId": {
"location": "uri",
"locationName": "TrafficDistributionGroupId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteUseCase": {
"http": {
"method": "DELETE",
"requestUri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"IntegrationAssociationId",
"UseCaseId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"IntegrationAssociationId": {
"location": "uri",
"locationName": "IntegrationAssociationId"
},
"UseCaseId": {
"location": "uri",
"locationName": "UseCaseId"
}
}
}
},
"DeleteUser": {
"http": {
"method": "DELETE",
"requestUri": "/users/{InstanceId}/{UserId}"
},
"input": {
"type": "structure",
"required": [
"InstanceId",
"UserId"
],
"members": {
"InstanceId": {
"location": "uri",
"locationName": "InstanceId"
},
"UserId": {
"location": "uri",
"locationName": "UserId"
}
}
}
},
"DeleteUserHierarchyGroup": {
"http": {
"method": "DELETE",
"requestUri": "/user-hierarchy-group