{ "version":"2.0", "metadata":{ "apiVersion":"2024-04-23", "auth":["aws.auth#sigv4"], "endpointPrefix":"connect-campaigns", "jsonVersion":"1.1", "protocol":"rest-json", "protocols":["rest-json"], "serviceFullName":"AmazonConnectCampaignServiceV2", "serviceId":"ConnectCampaignsV2", "signatureVersion":"v4", "signingName":"connect-campaigns", "uid":"connectcampaignsv2-2024-04-23" }, "operations":{ "CreateCampaign":{ "name":"CreateCampaign", "http":{ "method":"PUT", "requestUri":"/v2/campaigns", "responseCode":200 }, "input":{"shape":"CreateCampaignRequest"}, "output":{"shape":"CreateCampaignResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"
Creates a campaign for the specified Amazon Connect account. This API is idempotent.
", "idempotent":true }, "DeleteCampaign":{ "name":"DeleteCampaign", "http":{ "method":"DELETE", "requestUri":"/v2/campaigns/{id}", "responseCode":200 }, "input":{"shape":"DeleteCampaignRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Deletes a campaign from the specified Amazon Connect account.
", "idempotent":true }, "DeleteCampaignChannelSubtypeConfig":{ "name":"DeleteCampaignChannelSubtypeConfig", "http":{ "method":"DELETE", "requestUri":"/v2/campaigns/{id}/channel-subtype-config", "responseCode":200 }, "input":{"shape":"DeleteCampaignChannelSubtypeConfigRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"} ], "documentation":"Deletes the channel subtype config of a campaign. This API is idempotent.
", "idempotent":true }, "DeleteCampaignCommunicationLimits":{ "name":"DeleteCampaignCommunicationLimits", "http":{ "method":"DELETE", "requestUri":"/v2/campaigns/{id}/communication-limits", "responseCode":200 }, "input":{"shape":"DeleteCampaignCommunicationLimitsRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"} ], "documentation":"Deletes the communication limits config for a campaign. This API is idempotent.
", "idempotent":true }, "DeleteCampaignCommunicationTime":{ "name":"DeleteCampaignCommunicationTime", "http":{ "method":"DELETE", "requestUri":"/v2/campaigns/{id}/communication-time", "responseCode":200 }, "input":{"shape":"DeleteCampaignCommunicationTimeRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"} ], "documentation":"Deletes the communication time config for a campaign. This API is idempotent.
", "idempotent":true }, "DeleteConnectInstanceConfig":{ "name":"DeleteConnectInstanceConfig", "http":{ "method":"DELETE", "requestUri":"/v2/connect-instance/{connectInstanceId}/config", "responseCode":200 }, "input":{"shape":"DeleteConnectInstanceConfigRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidStateException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes a connect instance config from the specified AWS account.
", "idempotent":true }, "DeleteConnectInstanceIntegration":{ "name":"DeleteConnectInstanceIntegration", "http":{ "method":"POST", "requestUri":"/v2/connect-instance/{connectInstanceId}/integrations/delete", "responseCode":200 }, "input":{"shape":"DeleteConnectInstanceIntegrationRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Delete the integration for the specified Amazon Connect instance.
" }, "DeleteInstanceOnboardingJob":{ "name":"DeleteInstanceOnboardingJob", "http":{ "method":"DELETE", "requestUri":"/v2/connect-instance/{connectInstanceId}/onboarding", "responseCode":200 }, "input":{"shape":"DeleteInstanceOnboardingJobRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidStateException"} ], "documentation":"Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
", "idempotent":true }, "DescribeCampaign":{ "name":"DescribeCampaign", "http":{ "method":"GET", "requestUri":"/v2/campaigns/{id}", "responseCode":200 }, "input":{"shape":"DescribeCampaignRequest"}, "output":{"shape":"DescribeCampaignResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Describes the specific campaign.
", "readonly":true }, "GetCampaignState":{ "name":"GetCampaignState", "http":{ "method":"GET", "requestUri":"/v2/campaigns/{id}/state", "responseCode":200 }, "input":{"shape":"GetCampaignStateRequest"}, "output":{"shape":"GetCampaignStateResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Get state of a campaign for the specified Amazon Connect account.
" }, "GetCampaignStateBatch":{ "name":"GetCampaignStateBatch", "http":{ "method":"POST", "requestUri":"/v2/campaigns-state", "responseCode":200 }, "input":{"shape":"GetCampaignStateBatchRequest"}, "output":{"shape":"GetCampaignStateBatchResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Get state of campaigns for the specified Amazon Connect account.
" }, "GetConnectInstanceConfig":{ "name":"GetConnectInstanceConfig", "http":{ "method":"GET", "requestUri":"/v2/connect-instance/{connectInstanceId}/config", "responseCode":200 }, "input":{"shape":"GetConnectInstanceConfigRequest"}, "output":{"shape":"GetConnectInstanceConfigResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Get the specific Connect instance config.
", "readonly":true }, "GetInstanceCommunicationLimits":{ "name":"GetInstanceCommunicationLimits", "http":{ "method":"GET", "requestUri":"/v2/connect-instance/{connectInstanceId}/communication-limits", "responseCode":200 }, "input":{"shape":"GetInstanceCommunicationLimitsRequest"}, "output":{"shape":"GetInstanceCommunicationLimitsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Get the instance communication limits.
", "readonly":true }, "GetInstanceOnboardingJobStatus":{ "name":"GetInstanceOnboardingJobStatus", "http":{ "method":"GET", "requestUri":"/v2/connect-instance/{connectInstanceId}/onboarding", "responseCode":200 }, "input":{"shape":"GetInstanceOnboardingJobStatusRequest"}, "output":{"shape":"GetInstanceOnboardingJobStatusResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Get the specific instance onboarding job status.
", "readonly":true }, "ListCampaigns":{ "name":"ListCampaigns", "http":{ "method":"POST", "requestUri":"/v2/campaigns-summary", "responseCode":200 }, "input":{"shape":"ListCampaignsRequest"}, "output":{"shape":"ListCampaignsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Provides summary information about the campaigns under the specified Amazon Connect account.
", "readonly":true }, "ListConnectInstanceIntegrations":{ "name":"ListConnectInstanceIntegrations", "http":{ "method":"GET", "requestUri":"/v2/connect-instance/{connectInstanceId}/integrations", "responseCode":200 }, "input":{"shape":"ListConnectInstanceIntegrationsRequest"}, "output":{"shape":"ListConnectInstanceIntegrationsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Provides summary information about the integration under the specified Connect instance.
", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/v2/tags/{arn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"List tags for a resource.
" }, "PauseCampaign":{ "name":"PauseCampaign", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/pause", "responseCode":200 }, "input":{"shape":"PauseCampaignRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Pauses a campaign for the specified Amazon Connect account.
" }, "PutConnectInstanceIntegration":{ "name":"PutConnectInstanceIntegration", "http":{ "method":"PUT", "requestUri":"/v2/connect-instance/{connectInstanceId}/integrations", "responseCode":200 }, "input":{"shape":"PutConnectInstanceIntegrationRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Put or update the integration for the specified Amazon Connect instance.
", "idempotent":true }, "PutInstanceCommunicationLimits":{ "name":"PutInstanceCommunicationLimits", "http":{ "method":"PUT", "requestUri":"/v2/connect-instance/{connectInstanceId}/communication-limits", "responseCode":200 }, "input":{"shape":"PutInstanceCommunicationLimitsRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"} ], "documentation":"Put the instance communication limits. This API is idempotent.
", "idempotent":true }, "PutOutboundRequestBatch":{ "name":"PutOutboundRequestBatch", "http":{ "method":"PUT", "requestUri":"/v2/campaigns/{id}/outbound-requests", "responseCode":200 }, "input":{"shape":"PutOutboundRequestBatchRequest"}, "output":{"shape":"PutOutboundRequestBatchResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates outbound requests for the specified campaign Amazon Connect account. This API is idempotent.
", "idempotent":true }, "PutProfileOutboundRequestBatch":{ "name":"PutProfileOutboundRequestBatch", "http":{ "method":"PUT", "requestUri":"/v2/campaigns/{id}/profile-outbound-requests", "responseCode":200 }, "input":{"shape":"PutProfileOutboundRequestBatchRequest"}, "output":{"shape":"PutProfileOutboundRequestBatchResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Takes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent.
", "idempotent":true }, "ResumeCampaign":{ "name":"ResumeCampaign", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/resume", "responseCode":200 }, "input":{"shape":"ResumeCampaignRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Stops a campaign for the specified Amazon Connect account.
" }, "StartCampaign":{ "name":"StartCampaign", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/start", "responseCode":200 }, "input":{"shape":"StartCampaignRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Starts a campaign for the specified Amazon Connect account.
" }, "StartInstanceOnboardingJob":{ "name":"StartInstanceOnboardingJob", "http":{ "method":"PUT", "requestUri":"/v2/connect-instance/{connectInstanceId}/onboarding", "responseCode":200 }, "input":{"shape":"StartInstanceOnboardingJobRequest"}, "output":{"shape":"StartInstanceOnboardingJobResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Onboard the specific Amazon Connect instance to Connect Campaigns.
", "idempotent":true }, "StopCampaign":{ "name":"StopCampaign", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/stop", "responseCode":200 }, "input":{"shape":"StopCampaignRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Stops a campaign for the specified Amazon Connect account.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/v2/tags/{arn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Tag a resource.
", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/v2/tags/{arn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Untag a resource.
", "idempotent":true }, "UpdateCampaignChannelSubtypeConfig":{ "name":"UpdateCampaignChannelSubtypeConfig", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/channel-subtype-config", "responseCode":200 }, "input":{"shape":"UpdateCampaignChannelSubtypeConfigRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates the channel subtype config of a campaign. This API is idempotent.
", "idempotent":true }, "UpdateCampaignCommunicationLimits":{ "name":"UpdateCampaignCommunicationLimits", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/communication-limits", "responseCode":200 }, "input":{"shape":"UpdateCampaignCommunicationLimitsRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates the communication limits config for a campaign. This API is idempotent.
", "idempotent":true }, "UpdateCampaignCommunicationTime":{ "name":"UpdateCampaignCommunicationTime", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/communication-time", "responseCode":200 }, "input":{"shape":"UpdateCampaignCommunicationTimeRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates the communication time config for a campaign. This API is idempotent.
", "idempotent":true }, "UpdateCampaignFlowAssociation":{ "name":"UpdateCampaignFlowAssociation", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/flow", "responseCode":200 }, "input":{"shape":"UpdateCampaignFlowAssociationRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates the campaign flow associated with a campaign. This API is idempotent.
", "idempotent":true }, "UpdateCampaignName":{ "name":"UpdateCampaignName", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/name", "responseCode":200 }, "input":{"shape":"UpdateCampaignNameRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates the name of a campaign. This API is idempotent.
", "idempotent":true }, "UpdateCampaignSchedule":{ "name":"UpdateCampaignSchedule", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/schedule", "responseCode":200 }, "input":{"shape":"UpdateCampaignScheduleRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates the schedule for a campaign. This API is idempotent.
", "idempotent":true }, "UpdateCampaignSource":{ "name":"UpdateCampaignSource", "http":{ "method":"POST", "requestUri":"/v2/campaigns/{id}/source", "responseCode":200 }, "input":{"shape":"UpdateCampaignSourceRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates the campaign source with a campaign. This API is idempotent.
", "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "xAmzErrorType":{ "shape":"XAmazonErrorType", "location":"header", "locationName":"x-amzn-ErrorType" } }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AgentAction":{ "type":"string", "documentation":"Actions that can performed on a contact by an agent
", "enum":["DISCARD"] }, "AgentActions":{ "type":"list", "member":{"shape":"AgentAction"}, "documentation":"Actions that can be performed by agent during preview phase.
" }, "AgentlessConfig":{ "type":"structure", "members":{}, "documentation":"Agentless config
" }, "AnswerMachineDetectionConfig":{ "type":"structure", "required":["enableAnswerMachineDetection"], "members":{ "enableAnswerMachineDetection":{ "shape":"Boolean", "documentation":"Enable or disable answering machine detection
" }, "awaitAnswerMachinePrompt":{ "shape":"Boolean", "documentation":"Enable or disable await answer machine prompt
" } }, "documentation":"Answering Machine Detection config
" }, "Arn":{ "type":"string", "documentation":"Amazon Resource Names(ARN)
", "max":500, "min":20, "pattern":"arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\\:[^:]+)?" }, "AttributeName":{ "type":"string", "documentation":"The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.
", "max":32767, "min":0, "pattern":"[a-zA-Z0-9\\-_]+" }, "AttributeValue":{ "type":"string", "documentation":"The value of the attribute.
", "max":32767, "min":0, "pattern":".*" }, "Attributes":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"}, "documentation":"A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
", "sensitive":true }, "BandwidthAllocation":{ "type":"double", "documentation":"The bandwidth allocation of a queue resource.
", "box":true, "max":1, "min":0 }, "Boolean":{ "type":"boolean", "box":true }, "Campaign":{ "type":"structure", "required":[ "id", "arn", "name", "connectInstanceId" ], "members":{ "id":{"shape":"CampaignId"}, "arn":{"shape":"CampaignArn"}, "name":{"shape":"CampaignName"}, "connectInstanceId":{"shape":"InstanceId"}, "channelSubtypeConfig":{"shape":"ChannelSubtypeConfig"}, "type":{"shape":"ExternalCampaignType"}, "source":{"shape":"Source"}, "connectCampaignFlowArn":{"shape":"Arn"}, "schedule":{"shape":"Schedule"}, "communicationTimeConfig":{"shape":"CommunicationTimeConfig"}, "communicationLimitsOverride":{"shape":"CommunicationLimitsConfig"}, "tags":{"shape":"TagMap"} }, "documentation":"An Amazon Connect campaign.
" }, "CampaignArn":{ "type":"string", "documentation":"The resource name of an Amazon Connect campaign.
", "max":500, "min":20 }, "CampaignDeletionPolicy":{ "type":"string", "documentation":"Enumeration of the policies to enact on existing campaigns during instance config deletion
", "enum":[ "RETAIN_ALL", "DELETE_ALL" ] }, "CampaignFilters":{ "type":"structure", "members":{ "instanceIdFilter":{"shape":"InstanceIdFilter"} }, "documentation":"Filter model by type
" }, "CampaignId":{ "type":"string", "documentation":"Identifier representing a Campaign
", "max":256, "min":1, "pattern":"[-:/a-zA-Z0-9]+" }, "CampaignName":{ "type":"string", "documentation":"The name of an Amazon Connect Campaign name.
", "max":127, "min":1 }, "CampaignState":{ "type":"string", "documentation":"State of a campaign
", "enum":[ "Initialized", "Running", "Paused", "Stopped", "Failed", "Completed" ] }, "CampaignSummary":{ "type":"structure", "required":[ "id", "arn", "name", "connectInstanceId", "channelSubtypes" ], "members":{ "id":{"shape":"CampaignId"}, "arn":{"shape":"CampaignArn"}, "name":{"shape":"CampaignName"}, "connectInstanceId":{"shape":"InstanceId"}, "channelSubtypes":{"shape":"ChannelSubtypeList"}, "type":{"shape":"ExternalCampaignType"}, "schedule":{"shape":"Schedule"}, "connectCampaignFlowArn":{"shape":"Arn"} }, "documentation":"An Amazon Connect campaign summary.
" }, "CampaignSummaryList":{ "type":"list", "member":{"shape":"CampaignSummary"}, "documentation":"A list of Amazon Connect campaigns.
" }, "Capacity":{ "type":"double", "documentation":"Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
", "box":true, "max":1, "min":0.01 }, "ChannelSubtype":{ "type":"string", "documentation":"The type of campaign channel subtype.
", "enum":[ "TELEPHONY", "SMS", "EMAIL", "WHATSAPP" ] }, "ChannelSubtypeConfig":{ "type":"structure", "members":{ "telephony":{"shape":"TelephonyChannelSubtypeConfig"}, "sms":{"shape":"SmsChannelSubtypeConfig"}, "email":{"shape":"EmailChannelSubtypeConfig"}, "whatsApp":{"shape":"WhatsAppChannelSubtypeConfig"} }, "documentation":"Campaign Channel Subtype config
" }, "ChannelSubtypeList":{ "type":"list", "member":{"shape":"ChannelSubtype"}, "documentation":"Channel subtype list
" }, "ChannelSubtypeParameters":{ "type":"structure", "members":{ "telephony":{"shape":"TelephonyChannelSubtypeParameters"}, "sms":{"shape":"SmsChannelSubtypeParameters"}, "email":{"shape":"EmailChannelSubtypeParameters"}, "whatsApp":{"shape":"WhatsAppChannelSubtypeParameters"} }, "documentation":"ChannelSubtypeParameters for an outbound request
", "union":true }, "ClientToken":{ "type":"string", "documentation":"Client provided parameter used for idempotency. Its value must be unique for each request.
", "max":200, "min":0, "pattern":"[a-zA-Z0-9_\\-.]*" }, "CommunicationLimit":{ "type":"structure", "required":[ "maxCountPerRecipient", "frequency", "unit" ], "members":{ "maxCountPerRecipient":{ "shape":"CommunicationLimitMaxCountPerRecipientInteger", "documentation":"Maximum number of contacts allowed for a given target within the given frequency.
" }, "frequency":{ "shape":"CommunicationLimitFrequencyInteger", "documentation":"The number of days to consider with regards to this limit.
" }, "unit":{"shape":"CommunicationLimitTimeUnit"} }, "documentation":"Communication Limit
" }, "CommunicationLimitFrequencyInteger":{ "type":"integer", "box":true, "max":30, "min":1 }, "CommunicationLimitList":{ "type":"list", "member":{"shape":"CommunicationLimit"}, "documentation":"List of communication limit
", "max":2, "min":0 }, "CommunicationLimitMaxCountPerRecipientInteger":{ "type":"integer", "box":true, "min":1 }, "CommunicationLimitTimeUnit":{ "type":"string", "documentation":"The communication limit time unit.
", "enum":["DAY"] }, "CommunicationLimits":{ "type":"structure", "members":{ "communicationLimitsList":{"shape":"CommunicationLimitList"} }, "documentation":"Communication limits
", "union":true }, "CommunicationLimitsConfig":{ "type":"structure", "members":{ "allChannelSubtypes":{"shape":"CommunicationLimits"}, "instanceLimitsHandling":{"shape":"InstanceLimitsHandling"} }, "documentation":"Communication limits config
" }, "CommunicationLimitsConfigType":{ "type":"string", "documentation":"The type of campaign communication limits config.
", "enum":["ALL_CHANNEL_SUBTYPES"] }, "CommunicationTimeConfig":{ "type":"structure", "required":["localTimeZoneConfig"], "members":{ "localTimeZoneConfig":{"shape":"LocalTimeZoneConfig"}, "telephony":{"shape":"TimeWindow"}, "sms":{"shape":"TimeWindow"}, "email":{"shape":"TimeWindow"}, "whatsApp":{"shape":"TimeWindow"} }, "documentation":"Campaign communication time config
" }, "CommunicationTimeConfigType":{ "type":"string", "documentation":"The type of campaign communication time config
", "enum":[ "TELEPHONY", "SMS", "EMAIL", "WHATSAPP" ] }, "ConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "xAmzErrorType":{ "shape":"XAmazonErrorType", "location":"header", "locationName":"x-amzn-ErrorType" } }, "documentation":"The request could not be processed because of conflict in the current state of the resource.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ContactFlowId":{ "type":"string", "documentation":"The identifier of the contact flow for the outbound call.
", "max":500, "min":0 }, "CreateCampaignRequest":{ "type":"structure", "required":[ "name", "connectInstanceId" ], "members":{ "name":{"shape":"CampaignName"}, "connectInstanceId":{"shape":"InstanceId"}, "channelSubtypeConfig":{"shape":"ChannelSubtypeConfig"}, "type":{"shape":"ExternalCampaignType"}, "source":{"shape":"Source"}, "connectCampaignFlowArn":{"shape":"Arn"}, "schedule":{"shape":"Schedule"}, "communicationTimeConfig":{"shape":"CommunicationTimeConfig"}, "communicationLimitsOverride":{"shape":"CommunicationLimitsConfig"}, "tags":{"shape":"TagMap"} }, "documentation":"The request for CreateCampaign API.
" }, "CreateCampaignResponse":{ "type":"structure", "members":{ "id":{"shape":"CampaignId"}, "arn":{"shape":"CampaignArn"}, "tags":{"shape":"TagMap"} }, "documentation":"The response for Create Campaign API
" }, "CustomerProfilesIntegrationConfig":{ "type":"structure", "required":[ "domainArn", "objectTypeNames" ], "members":{ "domainArn":{"shape":"Arn"}, "objectTypeNames":{"shape":"ObjectTypeNamesMap"} }, "documentation":"Customer Profiles integration config
" }, "CustomerProfilesIntegrationIdentifier":{ "type":"structure", "required":["domainArn"], "members":{ "domainArn":{"shape":"Arn"} }, "documentation":"Customer Profiles integration identifier
" }, "CustomerProfilesIntegrationSummary":{ "type":"structure", "required":[ "domainArn", "objectTypeNames" ], "members":{ "domainArn":{"shape":"Arn"}, "objectTypeNames":{"shape":"ObjectTypeNamesMap"} }, "documentation":"Customer Profiles integration summary
" }, "DailyHours":{ "type":"map", "key":{"shape":"DayOfWeek"}, "value":{"shape":"TimeRangeList"}, "documentation":"Daily Hours map
" }, "DayOfWeek":{ "type":"string", "documentation":"Day of week enum
", "enum":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "DeleteCampaignChannelSubtypeConfigRequest":{ "type":"structure", "required":[ "id", "channelSubtype" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "channelSubtype":{ "shape":"ChannelSubtype", "location":"querystring", "locationName":"channelSubtype" } }, "documentation":"The request for DeleteCampaignChannelSubtypeConfig API.
" }, "DeleteCampaignCommunicationLimitsRequest":{ "type":"structure", "required":[ "id", "config" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "config":{ "shape":"CommunicationLimitsConfigType", "location":"querystring", "locationName":"config" } }, "documentation":"The request for DeleteCampaignCommunicationLimits API.
" }, "DeleteCampaignCommunicationTimeRequest":{ "type":"structure", "required":[ "id", "config" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "config":{ "shape":"CommunicationTimeConfigType", "location":"querystring", "locationName":"config" } }, "documentation":"The request for DeleteCampaignCommunicationTime API.
" }, "DeleteCampaignRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"The request for DeleteCampaign API.
" }, "DeleteConnectInstanceConfigRequest":{ "type":"structure", "required":["connectInstanceId"], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" }, "campaignDeletionPolicy":{ "shape":"CampaignDeletionPolicy", "location":"querystring", "locationName":"campaignDeletionPolicy" } }, "documentation":"The request for DeleteConnectInstanceConfig API.
" }, "DeleteConnectInstanceIntegrationRequest":{ "type":"structure", "required":[ "connectInstanceId", "integrationIdentifier" ], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" }, "integrationIdentifier":{"shape":"IntegrationIdentifier"} }, "documentation":"The request for DeleteConnectInstanceIntegration API.
" }, "DeleteInstanceOnboardingJobRequest":{ "type":"structure", "required":["connectInstanceId"], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" } }, "documentation":"The request for DeleteInstanceOnboardingJob API.
" }, "DescribeCampaignRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"The request for DescribeCampaign API.
" }, "DescribeCampaignResponse":{ "type":"structure", "members":{ "campaign":{"shape":"Campaign"} }, "documentation":"The response for DescribeCampaign API.
" }, "DestinationPhoneNumber":{ "type":"string", "documentation":"The phone number of the customer, in E.164 format.
", "max":20, "min":0, "pattern":"[\\d\\-+]*", "sensitive":true }, "DialRequestId":{ "type":"string", "documentation":"Identifier representing a Dial request
", "max":256, "min":1, "pattern":"[-_.a-zA-Z0-9]+" }, "EmailAddress":{ "type":"string", "documentation":"Source/Destination Email address used for Email messages
", "max":255, "min":1, "pattern":".*[^\\s@]+@[^\\s@]+\\.[^\\s@]+.*", "sensitive":true }, "EmailChannelSubtypeConfig":{ "type":"structure", "required":[ "outboundMode", "defaultOutboundConfig" ], "members":{ "capacity":{"shape":"Capacity"}, "outboundMode":{"shape":"EmailOutboundMode"}, "defaultOutboundConfig":{"shape":"EmailOutboundConfig"} }, "documentation":"Email Channel Subtype config
" }, "EmailChannelSubtypeParameters":{ "type":"structure", "required":[ "destinationEmailAddress", "templateParameters" ], "members":{ "destinationEmailAddress":{"shape":"EmailAddress"}, "connectSourceEmailAddress":{"shape":"EmailAddress"}, "templateArn":{"shape":"Arn"}, "templateParameters":{"shape":"Attributes"} }, "documentation":"Parameters for the Email Channel Subtype
" }, "EmailDisplayName":{ "type":"string", "documentation":"Display name for Email Address
", "max":256, "min":0, "sensitive":true }, "EmailOutboundConfig":{ "type":"structure", "required":[ "connectSourceEmailAddress", "wisdomTemplateArn" ], "members":{ "connectSourceEmailAddress":{"shape":"EmailAddress"}, "sourceEmailAddressDisplayName":{"shape":"EmailDisplayName"}, "wisdomTemplateArn":{"shape":"Arn"} }, "documentation":"Default Email Outbound config
" }, "EmailOutboundMode":{ "type":"structure", "members":{ "agentless":{"shape":"AgentlessConfig"} }, "documentation":"Email Outbound Mode
", "union":true }, "Enabled":{ "type":"boolean", "documentation":"Boolean to indicate if custom encryption has been enabled.
" }, "EncryptionConfig":{ "type":"structure", "required":["enabled"], "members":{ "enabled":{"shape":"Enabled"}, "encryptionType":{"shape":"EncryptionType"}, "keyArn":{"shape":"EncryptionKey"} }, "documentation":"Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported
" }, "EncryptionKey":{ "type":"string", "documentation":"KMS key id/arn for encryption config.
", "max":500, "min":0 }, "EncryptionType":{ "type":"string", "documentation":"Server-side encryption type.
", "enum":["KMS"] }, "EventTrigger":{ "type":"structure", "members":{ "customerProfilesDomainArn":{"shape":"Arn"} }, "documentation":"Event trigger of the campaign
" }, "EventType":{ "type":"string", "documentation":"Enumeration of Customer Profiles event type
", "enum":[ "Campaign-Email", "Campaign-SMS", "Campaign-Telephony", "Campaign-Orchestration" ] }, "ExternalCampaignType":{ "type":"string", "documentation":"The type of campaign externally exposed in APIs.
", "enum":[ "MANAGED", "JOURNEY" ] }, "FailedCampaignStateResponse":{ "type":"structure", "members":{ "campaignId":{"shape":"CampaignId"}, "failureCode":{"shape":"GetCampaignStateBatchFailureCode"} }, "documentation":"Failed response of campaign state
" }, "FailedCampaignStateResponseList":{ "type":"list", "member":{"shape":"FailedCampaignStateResponse"}, "documentation":"List of failed requests of campaign state
", "max":25, "min":0 }, "FailedProfileOutboundRequest":{ "type":"structure", "members":{ "clientToken":{"shape":"ClientToken"}, "id":{"shape":"ProfileOutboundRequestId"}, "failureCode":{"shape":"ProfileOutboundRequestFailureCode"} }, "documentation":"Failure details for a profile outbound request
" }, "FailedProfileOutboundRequestList":{ "type":"list", "member":{"shape":"FailedProfileOutboundRequest"}, "documentation":"List of failed profile outbound requests
", "max":20, "min":0 }, "FailedRequest":{ "type":"structure", "members":{ "clientToken":{"shape":"ClientToken"}, "id":{"shape":"DialRequestId"}, "failureCode":{"shape":"FailureCode"} }, "documentation":"A failed request identified by the unique client token.
" }, "FailedRequestList":{ "type":"list", "member":{"shape":"FailedRequest"}, "documentation":"A list of failed requests.
", "max":25, "min":0 }, "FailureCode":{ "type":"string", "documentation":"A predefined code indicating the error that caused the failure.
", "enum":[ "InvalidInput", "RequestThrottled", "UnknownError", "BufferLimitExceeded" ] }, "GetCampaignStateBatchFailureCode":{ "type":"string", "documentation":"A predefined code indicating the error that caused the failure in getting state of campaigns
", "enum":[ "ResourceNotFound", "UnknownError" ] }, "GetCampaignStateBatchRequest":{ "type":"structure", "required":["campaignIds"], "members":{ "campaignIds":{"shape":"GetCampaignStateBatchRequestCampaignIdsList"} }, "documentation":"The request for GetCampaignStateBatch API.
" }, "GetCampaignStateBatchRequestCampaignIdsList":{ "type":"list", "member":{"shape":"CampaignId"}, "documentation":"List of CampaignId
", "max":25, "min":1 }, "GetCampaignStateBatchResponse":{ "type":"structure", "members":{ "successfulRequests":{"shape":"SuccessfulCampaignStateResponseList"}, "failedRequests":{"shape":"FailedCampaignStateResponseList"} }, "documentation":"The response for GetCampaignStateBatch API.
" }, "GetCampaignStateRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"The request for GetCampaignState API.
" }, "GetCampaignStateResponse":{ "type":"structure", "members":{ "state":{"shape":"CampaignState"} }, "documentation":"The response for GetCampaignState API.
" }, "GetConnectInstanceConfigRequest":{ "type":"structure", "required":["connectInstanceId"], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" } }, "documentation":"The request for GetConnectInstanceConfig API.
" }, "GetConnectInstanceConfigResponse":{ "type":"structure", "members":{ "connectInstanceConfig":{"shape":"InstanceConfig"} }, "documentation":"The response for GetConnectInstanceConfig API.
" }, "GetInstanceCommunicationLimitsRequest":{ "type":"structure", "required":["connectInstanceId"], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" } }, "documentation":"The request for GetInstanceCommunicationLimits API.
" }, "GetInstanceCommunicationLimitsResponse":{ "type":"structure", "members":{ "communicationLimitsConfig":{"shape":"InstanceCommunicationLimitsConfig"} }, "documentation":"The response for GetInstanceCommunicationLimits API.
" }, "GetInstanceOnboardingJobStatusRequest":{ "type":"structure", "required":["connectInstanceId"], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" } }, "documentation":"The request for GetInstanceOnboardingJobStatus API.
" }, "GetInstanceOnboardingJobStatusResponse":{ "type":"structure", "members":{ "connectInstanceOnboardingJobStatus":{"shape":"InstanceOnboardingJobStatus"} }, "documentation":"The response for GetInstanceOnboardingJobStatus API.
" }, "InstanceCommunicationLimitsConfig":{ "type":"structure", "members":{ "allChannelSubtypes":{"shape":"CommunicationLimits"} }, "documentation":"Instance Communication limits config
" }, "InstanceConfig":{ "type":"structure", "required":[ "connectInstanceId", "serviceLinkedRoleArn", "encryptionConfig" ], "members":{ "connectInstanceId":{"shape":"InstanceId"}, "serviceLinkedRoleArn":{"shape":"ServiceLinkedRoleArn"}, "encryptionConfig":{"shape":"EncryptionConfig"} }, "documentation":"Instance config object
" }, "InstanceId":{ "type":"string", "documentation":"Amazon Connect Instance Id
", "max":256, "min":1, "pattern":"[-_.a-zA-Z0-9]+" }, "InstanceIdFilter":{ "type":"structure", "required":[ "value", "operator" ], "members":{ "value":{"shape":"InstanceId"}, "operator":{"shape":"InstanceIdFilterOperator"} }, "documentation":"Connect instance identifier filter
" }, "InstanceIdFilterOperator":{ "type":"string", "documentation":"Operators for Connect instance identifier filter
", "enum":["Eq"] }, "InstanceLimitsHandling":{ "type":"string", "documentation":"Instance limits handling
", "enum":[ "OPT_IN", "OPT_OUT" ] }, "InstanceOnboardingJobFailureCode":{ "type":"string", "documentation":"Enumeration of the possible failure codes for instance onboarding job
", "enum":[ "EVENT_BRIDGE_ACCESS_DENIED", "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED", "IAM_ACCESS_DENIED", "KMS_ACCESS_DENIED", "KMS_KEY_NOT_FOUND", "INTERNAL_FAILURE" ] }, "InstanceOnboardingJobStatus":{ "type":"structure", "required":[ "connectInstanceId", "status" ], "members":{ "connectInstanceId":{"shape":"InstanceId"}, "status":{"shape":"InstanceOnboardingJobStatusCode"}, "failureCode":{"shape":"InstanceOnboardingJobFailureCode"} }, "documentation":"Instance onboarding job status object
" }, "InstanceOnboardingJobStatusCode":{ "type":"string", "documentation":"Enumeration of the possible states for instance onboarding job
", "enum":[ "IN_PROGRESS", "SUCCEEDED", "FAILED" ] }, "IntegrationConfig":{ "type":"structure", "members":{ "customerProfiles":{"shape":"CustomerProfilesIntegrationConfig"}, "qConnect":{"shape":"QConnectIntegrationConfig"}, "lambda":{"shape":"LambdaIntegrationConfig"} }, "documentation":"Integration config for Connect Instance
", "union":true }, "IntegrationIdentifier":{ "type":"structure", "members":{ "customerProfiles":{"shape":"CustomerProfilesIntegrationIdentifier"}, "qConnect":{"shape":"QConnectIntegrationIdentifier"}, "lambda":{"shape":"LambdaIntegrationIdentifier"} }, "documentation":"Integration identifier for Connect instance
", "union":true }, "IntegrationSummary":{ "type":"structure", "members":{ "customerProfiles":{"shape":"CustomerProfilesIntegrationSummary"}, "qConnect":{"shape":"QConnectIntegrationSummary"}, "lambda":{"shape":"LambdaIntegrationSummary"} }, "documentation":"Integration summary for Connect instance.
", "union":true }, "IntegrationSummaryList":{ "type":"list", "member":{"shape":"IntegrationSummary"}, "documentation":"A list of Amazon Connect Instance Integrations.
" }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "xAmzErrorType":{ "shape":"XAmazonErrorType", "location":"header", "locationName":"x-amzn-ErrorType" } }, "documentation":"Request processing failed because of an error or failure with the service.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "InvalidCampaignStateException":{ "type":"structure", "required":[ "state", "message" ], "members":{ "state":{"shape":"CampaignState"}, "message":{"shape":"String"}, "xAmzErrorType":{ "shape":"XAmazonErrorType", "location":"header", "locationName":"x-amzn-ErrorType" } }, "documentation":"The request could not be processed because of conflict in the current state of the campaign.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "InvalidStateException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "xAmzErrorType":{ "shape":"XAmazonErrorType", "location":"header", "locationName":"x-amzn-ErrorType" } }, "documentation":"The request could not be processed because of conflict in the current state.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "Iso8601Date":{ "type":"string", "documentation":"Date in ISO 8601 format, e.g. 2024-01-01
", "pattern":"\\d{4}-\\d{2}-\\d{2}" }, "Iso8601Duration":{ "type":"string", "documentation":"Time duration in ISO 8601 format
", "max":50, "min":0, "pattern":"P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?" }, "Iso8601Time":{ "type":"string", "documentation":"Time in ISO 8601 format, e.g. T23:11
", "pattern":"T\\d{2}:\\d{2}" }, "LambdaArn":{ "type":"string", "documentation":"Lambda ARN for integration with Connect instances
", "max":140, "min":1, "pattern":"arn:aws[a-zA-Z-]*:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:function:([a-zA-Z0-9-_]+)(:([a-zA-Z0-9-_]+))?" }, "LambdaIntegrationConfig":{ "type":"structure", "required":["functionArn"], "members":{ "functionArn":{"shape":"LambdaArn"} }, "documentation":"Lambda integration config
" }, "LambdaIntegrationIdentifier":{ "type":"structure", "required":["functionArn"], "members":{ "functionArn":{"shape":"LambdaArn"} }, "documentation":"Lambda integration identifier
" }, "LambdaIntegrationSummary":{ "type":"structure", "required":["functionArn"], "members":{ "functionArn":{"shape":"LambdaArn"} }, "documentation":"Lambda integration summary
" }, "ListCampaignsRequest":{ "type":"structure", "members":{ "maxResults":{"shape":"MaxResults"}, "nextToken":{"shape":"NextToken"}, "filters":{"shape":"CampaignFilters"} }, "documentation":"The request for ListCampaigns API.
" }, "ListCampaignsResponse":{ "type":"structure", "members":{ "nextToken":{"shape":"NextToken"}, "campaignSummaryList":{"shape":"CampaignSummaryList"} }, "documentation":"The response for ListCampaigns API.
" }, "ListConnectInstanceIntegrationsRequest":{ "type":"structure", "required":["connectInstanceId"], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"nextToken" } }, "documentation":"The request for ListConnectInstanceIntegrations API.
" }, "ListConnectInstanceIntegrationsResponse":{ "type":"structure", "members":{ "nextToken":{"shape":"NextToken"}, "integrationSummaryList":{"shape":"IntegrationSummaryList"} }, "documentation":"The response for ListConnectInstanceIntegrations API.
" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"Arn", "location":"uri", "locationName":"arn" } }, "documentation":"The request for ListTagsForResource API.
" }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{"shape":"TagMap"} }, "documentation":"The request for ListTagsForResource API.
" }, "LocalTimeZoneConfig":{ "type":"structure", "members":{ "defaultTimeZone":{"shape":"TimeZone"}, "localTimeZoneDetection":{"shape":"LocalTimeZoneDetection"} }, "documentation":"Local time zone config
" }, "LocalTimeZoneDetection":{ "type":"list", "member":{"shape":"LocalTimeZoneDetectionType"}, "documentation":"Local TimeZone Detection method list
" }, "LocalTimeZoneDetectionType":{ "type":"string", "documentation":"Local TimeZone Detection method.
", "enum":[ "ZIP_CODE", "AREA_CODE" ] }, "MaxResults":{ "type":"integer", "documentation":"The maximum number of results to return per page.
", "box":true, "max":50, "min":1 }, "NextToken":{ "type":"string", "documentation":"The token for the next set of results.
", "max":1000, "min":0 }, "ObjectTypeName":{ "type":"string", "documentation":"Object type name
", "max":255, "min":1 }, "ObjectTypeNamesMap":{ "type":"map", "key":{"shape":"EventType"}, "value":{"shape":"ObjectTypeName"}, "documentation":"Object type names map.
" }, "OpenHours":{ "type":"structure", "members":{ "dailyHours":{"shape":"DailyHours"} }, "documentation":"Open Hours config
", "union":true }, "OutboundRequest":{ "type":"structure", "required":[ "clientToken", "expirationTime", "channelSubtypeParameters" ], "members":{ "clientToken":{"shape":"ClientToken"}, "expirationTime":{"shape":"TimeStamp"}, "channelSubtypeParameters":{"shape":"ChannelSubtypeParameters"} }, "documentation":"An outbound request for a campaign.
" }, "OutboundRequestList":{ "type":"list", "member":{"shape":"OutboundRequest"}, "documentation":"A list of outbound requests.
", "max":25, "min":1 }, "PauseCampaignRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"The request for PauseCampaign API.
" }, "PredictiveConfig":{ "type":"structure", "required":["bandwidthAllocation"], "members":{ "bandwidthAllocation":{"shape":"BandwidthAllocation"} }, "documentation":"Predictive config
" }, "PreviewConfig":{ "type":"structure", "required":[ "bandwidthAllocation", "timeoutConfig" ], "members":{ "bandwidthAllocation":{"shape":"BandwidthAllocation"}, "timeoutConfig":{"shape":"TimeoutConfig"}, "agentActions":{"shape":"AgentActions"} }, "documentation":"Preview config
" }, "ProfileId":{ "type":"string", "documentation":"Identifier of the customer profile
", "pattern":"[a-f0-9]{32}" }, "ProfileOutboundRequest":{ "type":"structure", "required":[ "clientToken", "profileId" ], "members":{ "clientToken":{"shape":"ClientToken"}, "profileId":{"shape":"ProfileId"}, "expirationTime":{"shape":"TimeStamp"} }, "documentation":"Information about a profile outbound request
" }, "ProfileOutboundRequestFailureCode":{ "type":"string", "documentation":"Predefined code indicating the error that caused the failure
", "enum":[ "UnknownError", "ResourceNotFound", "Conflict", "RequestThrottled", "InvalidInput" ] }, "ProfileOutboundRequestId":{ "type":"string", "documentation":"Identifier of the profile outbound request
", "max":256, "min":0, "pattern":"[a-zA-Z0-9_\\-.]*" }, "ProfileOutboundRequestList":{ "type":"list", "member":{"shape":"ProfileOutboundRequest"}, "documentation":"List of profile outbound requests
", "max":20, "min":1 }, "ProgressiveConfig":{ "type":"structure", "required":["bandwidthAllocation"], "members":{ "bandwidthAllocation":{"shape":"BandwidthAllocation"} }, "documentation":"Progressive config
" }, "PutConnectInstanceIntegrationRequest":{ "type":"structure", "required":[ "connectInstanceId", "integrationConfig" ], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" }, "integrationConfig":{"shape":"IntegrationConfig"} }, "documentation":"The request for PutConnectInstanceIntegration API.
" }, "PutInstanceCommunicationLimitsRequest":{ "type":"structure", "required":[ "connectInstanceId", "communicationLimitsConfig" ], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" }, "communicationLimitsConfig":{"shape":"InstanceCommunicationLimitsConfig"} }, "documentation":"The request for PutInstanceCommunicationLimits API.
" }, "PutOutboundRequestBatchRequest":{ "type":"structure", "required":[ "id", "outboundRequests" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "outboundRequests":{"shape":"OutboundRequestList"} }, "documentation":"The request for PutOutboundRequestBatch API.
" }, "PutOutboundRequestBatchResponse":{ "type":"structure", "members":{ "successfulRequests":{"shape":"SuccessfulRequestList"}, "failedRequests":{"shape":"FailedRequestList"} }, "documentation":"The response for PutOutboundRequestBatch API.
" }, "PutProfileOutboundRequestBatchRequest":{ "type":"structure", "required":[ "id", "profileOutboundRequests" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "profileOutboundRequests":{"shape":"ProfileOutboundRequestList"} }, "documentation":"The request for PutProfileOutboundRequestBatch API
" }, "PutProfileOutboundRequestBatchResponse":{ "type":"structure", "members":{ "successfulRequests":{"shape":"SuccessfulProfileOutboundRequestList"}, "failedRequests":{"shape":"FailedProfileOutboundRequestList"} }, "documentation":"The response for PutProfileOutboundRequestBatch API
" }, "QConnectIntegrationConfig":{ "type":"structure", "required":["knowledgeBaseArn"], "members":{ "knowledgeBaseArn":{"shape":"Arn"} }, "documentation":"Q Connect integration config
" }, "QConnectIntegrationIdentifier":{ "type":"structure", "required":["knowledgeBaseArn"], "members":{ "knowledgeBaseArn":{"shape":"Arn"} }, "documentation":"Q Connect integration identifier
" }, "QConnectIntegrationSummary":{ "type":"structure", "required":["knowledgeBaseArn"], "members":{ "knowledgeBaseArn":{"shape":"Arn"} }, "documentation":"Q Connect integration summary
" }, "QueueId":{ "type":"string", "documentation":"The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
", "max":500, "min":0 }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "xAmzErrorType":{ "shape":"XAmazonErrorType", "location":"header", "locationName":"x-amzn-ErrorType" } }, "documentation":"The specified resource was not found.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "RestrictedPeriod":{ "type":"structure", "required":[ "startDate", "endDate" ], "members":{ "name":{"shape":"RestrictedPeriodName"}, "startDate":{"shape":"Iso8601Date"}, "endDate":{"shape":"Iso8601Date"} }, "documentation":"Restricted period
" }, "RestrictedPeriodList":{ "type":"list", "member":{"shape":"RestrictedPeriod"}, "documentation":"List of restricted period
" }, "RestrictedPeriodName":{ "type":"string", "documentation":"The name of a restricted period.
", "max":127, "min":1 }, "RestrictedPeriods":{ "type":"structure", "members":{ "restrictedPeriodList":{"shape":"RestrictedPeriodList"} }, "documentation":"Restricted period config
", "union":true }, "ResumeCampaignRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"The request for ResumeCampaign API.
" }, "RingTimeout":{ "type":"integer", "documentation":"Ring timeout for outbound calls
", "box":true, "max":60, "min":15 }, "Schedule":{ "type":"structure", "required":[ "startTime", "endTime" ], "members":{ "startTime":{"shape":"TimeStamp"}, "endTime":{"shape":"TimeStamp"}, "refreshFrequency":{"shape":"Iso8601Duration"} }, "documentation":"Campaign schedule
" }, "ServiceLinkedRoleArn":{ "type":"string", "documentation":"Service linked role arn
", "max":256, "min":0 }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "xAmzErrorType":{ "shape":"XAmazonErrorType", "location":"header", "locationName":"x-amzn-ErrorType" } }, "documentation":"Request would cause a service quota to be exceeded.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SmsChannelSubtypeConfig":{ "type":"structure", "required":[ "outboundMode", "defaultOutboundConfig" ], "members":{ "capacity":{"shape":"Capacity"}, "outboundMode":{"shape":"SmsOutboundMode"}, "defaultOutboundConfig":{"shape":"SmsOutboundConfig"} }, "documentation":"SMS Channel Subtype config
" }, "SmsChannelSubtypeParameters":{ "type":"structure", "required":[ "destinationPhoneNumber", "templateParameters" ], "members":{ "destinationPhoneNumber":{"shape":"DestinationPhoneNumber"}, "connectSourcePhoneNumberArn":{"shape":"Arn"}, "templateArn":{"shape":"Arn"}, "templateParameters":{"shape":"Attributes"} }, "documentation":"Parameters for the SMS Channel Subtype
" }, "SmsOutboundConfig":{ "type":"structure", "required":[ "connectSourcePhoneNumberArn", "wisdomTemplateArn" ], "members":{ "connectSourcePhoneNumberArn":{"shape":"Arn"}, "wisdomTemplateArn":{"shape":"Arn"} }, "documentation":"Default SMS Outbound config
" }, "SmsOutboundMode":{ "type":"structure", "members":{ "agentless":{"shape":"AgentlessConfig"} }, "documentation":"SMS Outbound Mode
", "union":true }, "Source":{ "type":"structure", "members":{ "customerProfilesSegmentArn":{"shape":"Arn"}, "eventTrigger":{"shape":"EventTrigger"} }, "documentation":"Source of the campaign
", "union":true }, "SourcePhoneNumber":{ "type":"string", "documentation":"The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
", "max":100, "min":0 }, "StartCampaignRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"The request for StartCampaign API.
" }, "StartInstanceOnboardingJobRequest":{ "type":"structure", "required":[ "connectInstanceId", "encryptionConfig" ], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" }, "encryptionConfig":{"shape":"EncryptionConfig"} }, "documentation":"The request for StartInstanceOnboardingJob API.
" }, "StartInstanceOnboardingJobResponse":{ "type":"structure", "members":{ "connectInstanceOnboardingJobStatus":{"shape":"InstanceOnboardingJobStatus"} }, "documentation":"The response for StartInstanceOnboardingJob API.
" }, "StopCampaignRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"The request for StopCampaign API.
" }, "String":{"type":"string"}, "SuccessfulCampaignStateResponse":{ "type":"structure", "members":{ "campaignId":{"shape":"CampaignId"}, "state":{"shape":"CampaignState"} }, "documentation":"Successful response of campaign state
" }, "SuccessfulCampaignStateResponseList":{ "type":"list", "member":{"shape":"SuccessfulCampaignStateResponse"}, "documentation":"List of successful response of campaign state
", "max":25, "min":0 }, "SuccessfulProfileOutboundRequest":{ "type":"structure", "members":{ "clientToken":{"shape":"ClientToken"}, "id":{"shape":"ProfileOutboundRequestId"} }, "documentation":"Success details for a profile outbound request
" }, "SuccessfulProfileOutboundRequestList":{ "type":"list", "member":{"shape":"SuccessfulProfileOutboundRequest"}, "documentation":"List of successful profile outbound requests
", "max":20, "min":0 }, "SuccessfulRequest":{ "type":"structure", "members":{ "clientToken":{"shape":"ClientToken"}, "id":{"shape":"DialRequestId"} }, "documentation":"A successful request identified by the unique client token.
" }, "SuccessfulRequestList":{ "type":"list", "member":{"shape":"SuccessfulRequest"}, "documentation":"A list of successful requests identified by the unique client token.
", "max":25, "min":0 }, "TagKey":{ "type":"string", "documentation":"The key of tag.
", "max":128, "min":1, "pattern":"(?!aws:)[a-zA-Z+-=._:/]+" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "documentation":"List of tag keys.
", "max":50, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "documentation":"Tag map with key and value.
" }, "TagResourceRequest":{ "type":"structure", "required":[ "arn", "tags" ], "members":{ "arn":{ "shape":"Arn", "location":"uri", "locationName":"arn" }, "tags":{"shape":"TagMap"} }, "documentation":"The request for TagResource API.
" }, "TagValue":{ "type":"string", "documentation":"The value of tag.
", "max":256, "min":0 }, "TelephonyChannelSubtypeConfig":{ "type":"structure", "required":[ "outboundMode", "defaultOutboundConfig" ], "members":{ "capacity":{"shape":"Capacity"}, "connectQueueId":{"shape":"QueueId"}, "outboundMode":{"shape":"TelephonyOutboundMode"}, "defaultOutboundConfig":{"shape":"TelephonyOutboundConfig"} }, "documentation":"Telephony Channel Subtype config
" }, "TelephonyChannelSubtypeParameters":{ "type":"structure", "required":[ "destinationPhoneNumber", "attributes" ], "members":{ "destinationPhoneNumber":{"shape":"DestinationPhoneNumber"}, "attributes":{"shape":"Attributes"}, "connectSourcePhoneNumber":{"shape":"SourcePhoneNumber"}, "answerMachineDetectionConfig":{"shape":"AnswerMachineDetectionConfig"}, "ringTimeout":{"shape":"RingTimeout"} }, "documentation":"Parameters for the Telephony Channel Subtype
" }, "TelephonyOutboundConfig":{ "type":"structure", "required":["connectContactFlowId"], "members":{ "connectContactFlowId":{"shape":"ContactFlowId"}, "connectSourcePhoneNumber":{"shape":"SourcePhoneNumber"}, "answerMachineDetectionConfig":{"shape":"AnswerMachineDetectionConfig"}, "ringTimeout":{"shape":"RingTimeout"} }, "documentation":"Default Telephony Outbound config
" }, "TelephonyOutboundMode":{ "type":"structure", "members":{ "progressive":{"shape":"ProgressiveConfig"}, "predictive":{"shape":"PredictiveConfig"}, "agentless":{"shape":"AgentlessConfig"}, "preview":{"shape":"PreviewConfig"} }, "documentation":"Telephony Outbound Mode
", "union":true }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "xAmzErrorType":{ "shape":"XAmazonErrorType", "location":"header", "locationName":"x-amzn-ErrorType" } }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "TimeRange":{ "type":"structure", "required":[ "startTime", "endTime" ], "members":{ "startTime":{"shape":"Iso8601Time"}, "endTime":{"shape":"Iso8601Time"} }, "documentation":"Time range in 24 hour format
" }, "TimeRangeList":{ "type":"list", "member":{"shape":"TimeRange"}, "documentation":"List of time range
" }, "TimeStamp":{ "type":"timestamp", "documentation":"Timestamp with no UTC offset or timezone
", "timestampFormat":"iso8601" }, "TimeWindow":{ "type":"structure", "required":["openHours"], "members":{ "openHours":{"shape":"OpenHours"}, "restrictedPeriods":{"shape":"RestrictedPeriods"} }, "documentation":"Time window config
" }, "TimeZone":{ "type":"string", "documentation":"Time Zone Id in the IANA format
", "max":50, "min":0, "pattern":"[a-zA-Z0-9_\\-/]*" }, "TimeoutConfig":{ "type":"structure", "required":["durationInSeconds"], "members":{ "durationInSeconds":{"shape":"TimeoutDuration"} }, "documentation":"Timeout Config for preview contacts.
" }, "TimeoutDuration":{ "type":"integer", "documentation":"Timeout duration for a preview contact in seconds.
", "box":true, "max":300, "min":1 }, "UntagResourceRequest":{ "type":"structure", "required":[ "arn", "tagKeys" ], "members":{ "arn":{ "shape":"Arn", "location":"uri", "locationName":"arn" }, "tagKeys":{ "shape":"TagKeyList", "location":"querystring", "locationName":"tagKeys" } }, "documentation":"The request for UntagResource API.
" }, "UpdateCampaignChannelSubtypeConfigRequest":{ "type":"structure", "required":[ "id", "channelSubtypeConfig" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "channelSubtypeConfig":{"shape":"ChannelSubtypeConfig"} }, "documentation":"The request for UpdateCampaignChannelSubtypeConfig API.
" }, "UpdateCampaignCommunicationLimitsRequest":{ "type":"structure", "required":[ "id", "communicationLimitsOverride" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "communicationLimitsOverride":{"shape":"CommunicationLimitsConfig"} }, "documentation":"The request for UpdateCampaignCommunicationLimits API.
" }, "UpdateCampaignCommunicationTimeRequest":{ "type":"structure", "required":[ "id", "communicationTimeConfig" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "communicationTimeConfig":{"shape":"CommunicationTimeConfig"} }, "documentation":"The request for UpdateCampaignCommunicationTime API.
" }, "UpdateCampaignFlowAssociationRequest":{ "type":"structure", "required":[ "id", "connectCampaignFlowArn" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "connectCampaignFlowArn":{"shape":"Arn"} }, "documentation":"The request for UpdateCampaignFlowAssociation API.
" }, "UpdateCampaignNameRequest":{ "type":"structure", "required":[ "id", "name" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "name":{"shape":"CampaignName"} }, "documentation":"The request for UpdateCampaignName API.
" }, "UpdateCampaignScheduleRequest":{ "type":"structure", "required":[ "id", "schedule" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "schedule":{"shape":"Schedule"} }, "documentation":"The request for UpdateCampaignSchedule API.
" }, "UpdateCampaignSourceRequest":{ "type":"structure", "required":[ "id", "source" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "source":{"shape":"Source"} }, "documentation":"The request for UpdateCampaignSource API.
" }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "xAmzErrorType":{ "shape":"XAmazonErrorType", "location":"header", "locationName":"x-amzn-ErrorType" } }, "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "WhatsAppChannelSubtypeConfig":{ "type":"structure", "required":[ "outboundMode", "defaultOutboundConfig" ], "members":{ "capacity":{"shape":"Capacity"}, "outboundMode":{"shape":"WhatsAppOutboundMode"}, "defaultOutboundConfig":{"shape":"WhatsAppOutboundConfig"} }, "documentation":"WhatsApp Channel Subtype config
" }, "WhatsAppChannelSubtypeParameters":{ "type":"structure", "required":[ "destinationPhoneNumber", "templateParameters" ], "members":{ "destinationPhoneNumber":{"shape":"DestinationPhoneNumber"}, "connectSourcePhoneNumberArn":{"shape":"Arn"}, "templateArn":{"shape":"Arn"}, "templateParameters":{"shape":"Attributes"} }, "documentation":"Parameters for the WhatsApp Channel Subtype
" }, "WhatsAppOutboundConfig":{ "type":"structure", "required":[ "connectSourcePhoneNumberArn", "wisdomTemplateArn" ], "members":{ "connectSourcePhoneNumberArn":{"shape":"Arn"}, "wisdomTemplateArn":{"shape":"Arn"} }, "documentation":"Default WhatsApp Outbound config
" }, "WhatsAppOutboundMode":{ "type":"structure", "members":{ "agentless":{"shape":"AgentlessConfig"} }, "documentation":"WhatsApp Outbound Mode
", "union":true }, "XAmazonErrorType":{ "type":"string", "documentation":"A header that defines the error encountered while processing the request.
" } }, "documentation":"Provide APIs to create and manage Amazon Connect Campaigns.
" }