{ "version":"2.0", "metadata":{ "apiVersion":"2021-01-30", "endpointPrefix":"connect-campaigns", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"AmazonConnectCampaignService", "serviceId":"ConnectCampaigns", "signatureVersion":"v4", "signingName":"connect-campaigns", "uid":"connectcampaigns-2021-01-30" }, "operations":{ "CreateCampaign":{ "name":"CreateCampaign", "http":{ "method":"PUT", "requestUri":"/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":"/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 }, "DeleteConnectInstanceConfig":{ "name":"DeleteConnectInstanceConfig", "http":{ "method":"DELETE", "requestUri":"/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 }, "DeleteInstanceOnboardingJob":{ "name":"DeleteInstanceOnboardingJob", "http":{ "method":"DELETE", "requestUri":"/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":"/campaigns/{id}", "responseCode":200 }, "input":{"shape":"DescribeCampaignRequest"}, "output":{"shape":"DescribeCampaignResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Describes the specific campaign.

" }, "GetCampaignState":{ "name":"GetCampaignState", "http":{ "method":"GET", "requestUri":"/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":"/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":"/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.

" }, "GetInstanceOnboardingJobStatus":{ "name":"GetInstanceOnboardingJobStatus", "http":{ "method":"GET", "requestUri":"/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.

" }, "ListCampaigns":{ "name":"ListCampaigns", "http":{ "method":"POST", "requestUri":"/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.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/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.

", "idempotent":true }, "PauseCampaign":{ "name":"PauseCampaign", "http":{ "method":"POST", "requestUri":"/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.

" }, "PutDialRequestBatch":{ "name":"PutDialRequestBatch", "http":{ "method":"PUT", "requestUri":"/campaigns/{id}/dial-requests", "responseCode":200 }, "input":{"shape":"PutDialRequestBatchRequest"}, "output":{"shape":"PutDialRequestBatchResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InvalidCampaignStateException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.

", "idempotent":true }, "ResumeCampaign":{ "name":"ResumeCampaign", "http":{ "method":"POST", "requestUri":"/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":"/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":"/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":"/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":"/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":"/tags/{arn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Untag a resource.

", "idempotent":true }, "UpdateCampaignDialerConfig":{ "name":"UpdateCampaignDialerConfig", "http":{ "method":"POST", "requestUri":"/campaigns/{id}/dialer-config", "responseCode":200 }, "input":{"shape":"UpdateCampaignDialerConfigRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Updates the dialer config of a campaign. This API is idempotent.

", "idempotent":true }, "UpdateCampaignName":{ "name":"UpdateCampaignName", "http":{ "method":"POST", "requestUri":"/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 }, "UpdateCampaignOutboundCallConfig":{ "name":"UpdateCampaignOutboundCallConfig", "http":{ "method":"POST", "requestUri":"/campaigns/{id}/outbound-call-config", "responseCode":200 }, "input":{"shape":"UpdateCampaignOutboundCallConfigRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates the outbound call config of 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 }, "AnswerMachineDetectionConfig":{ "type":"structure", "required":["enableAnswerMachineDetection"], "members":{ "enableAnswerMachineDetection":{ "shape":"Boolean", "documentation":"

Enable or disable answering machine detection

" } }, "documentation":"

Answering Machine Detection config

" }, "Arn":{ "type":"string", "documentation":"

Arn

", "max":500, "min":20, "pattern":"^arn:.*" }, "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 }, "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":[ "arn", "connectInstanceId", "dialerConfig", "id", "name", "outboundCallConfig" ], "members":{ "arn":{"shape":"CampaignArn"}, "connectInstanceId":{"shape":"InstanceId"}, "dialerConfig":{"shape":"DialerConfig"}, "id":{"shape":"CampaignId"}, "name":{"shape":"CampaignName"}, "outboundCallConfig":{"shape":"OutboundCallConfig"}, "tags":{"shape":"TagMap"} }, "documentation":"

An Amazon Connect campaign.

" }, "CampaignArn":{ "type":"string", "documentation":"

The resource name of an Amazon Connect campaign.

", "max":500, "min":20 }, "CampaignFilters":{ "type":"structure", "members":{ "instanceIdFilter":{"shape":"InstanceIdFilter"} }, "documentation":"

Filter model by type

" }, "CampaignId":{ "type":"string", "documentation":"

Identifier representing a Campaign

", "max":256, "min":0 }, "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" ] }, "CampaignSummary":{ "type":"structure", "required":[ "arn", "connectInstanceId", "id", "name" ], "members":{ "arn":{"shape":"CampaignArn"}, "connectInstanceId":{"shape":"InstanceId"}, "id":{"shape":"CampaignId"}, "name":{"shape":"CampaignName"} }, "documentation":"

An Amazon Connect campaign summary.

" }, "CampaignSummaryList":{ "type":"list", "member":{"shape":"CampaignSummary"}, "documentation":"

A list of Amazon Connect campaigns.

" }, "ClientToken":{ "type":"string", "documentation":"

Client provided parameter used for idempotency. Its value must be unique for each request.

", "max":64, "min":0 }, "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":[ "connectInstanceId", "dialerConfig", "name", "outboundCallConfig" ], "members":{ "connectInstanceId":{"shape":"InstanceId"}, "dialerConfig":{"shape":"DialerConfig"}, "name":{"shape":"CampaignName"}, "outboundCallConfig":{"shape":"OutboundCallConfig"}, "tags":{"shape":"TagMap"} }, "documentation":"

The request for Create Campaign API.

" }, "CreateCampaignResponse":{ "type":"structure", "members":{ "arn":{"shape":"CampaignArn"}, "id":{"shape":"CampaignId"}, "tags":{"shape":"TagMap"} }, "documentation":"

The response for Create Campaign API

" }, "DeleteCampaignRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"

DeleteCampaignRequest

" }, "DeleteConnectInstanceConfigRequest":{ "type":"structure", "required":["connectInstanceId"], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" } }, "documentation":"

DeleteCampaignRequest

" }, "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":"

DescribeCampaignRequests

" }, "DescribeCampaignResponse":{ "type":"structure", "members":{ "campaign":{"shape":"Campaign"} }, "documentation":"

DescribeCampaignResponse

" }, "DestinationPhoneNumber":{ "type":"string", "documentation":"

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

", "max":20, "min":0, "sensitive":true }, "DialRequest":{ "type":"structure", "required":[ "attributes", "clientToken", "expirationTime", "phoneNumber" ], "members":{ "attributes":{"shape":"Attributes"}, "clientToken":{"shape":"ClientToken"}, "expirationTime":{"shape":"TimeStamp"}, "phoneNumber":{"shape":"DestinationPhoneNumber"} }, "documentation":"

A dial request for a campaign.

" }, "DialRequestId":{ "type":"string", "documentation":"

Identifier representing a Dial request

" }, "DialRequestList":{ "type":"list", "member":{"shape":"DialRequest"}, "documentation":"

A list of dial requests.

", "max":25, "min":1 }, "DialerConfig":{ "type":"structure", "members":{ "predictiveDialerConfig":{"shape":"PredictiveDialerConfig"}, "progressiveDialerConfig":{"shape":"ProgressiveDialerConfig"} }, "documentation":"

The possible types of dialer config parameters

", "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"] }, "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 }, "FailedRequest":{ "type":"structure", "members":{ "clientToken":{"shape":"ClientToken"}, "failureCode":{"shape":"FailureCode"}, "id":{"shape":"DialRequestId"} }, "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" ] }, "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":"

GetCampaignStateBatchRequest

" }, "GetCampaignStateBatchRequestCampaignIdsList":{ "type":"list", "member":{"shape":"CampaignId"}, "documentation":"

List of CampaignId

", "max":25, "min":1 }, "GetCampaignStateBatchResponse":{ "type":"structure", "members":{ "failedRequests":{"shape":"FailedCampaignStateResponseList"}, "successfulRequests":{"shape":"SuccessfulCampaignStateResponseList"} }, "documentation":"

GetCampaignStateBatchResponse

" }, "GetCampaignStateRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"

GetCampaignStateRequest

" }, "GetCampaignStateResponse":{ "type":"structure", "members":{ "state":{"shape":"CampaignState"} }, "documentation":"

GetCampaignStateResponse

" }, "GetConnectInstanceConfigRequest":{ "type":"structure", "required":["connectInstanceId"], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" } }, "documentation":"

GetConnectInstanceConfigRequest

" }, "GetConnectInstanceConfigResponse":{ "type":"structure", "members":{ "connectInstanceConfig":{"shape":"InstanceConfig"} }, "documentation":"

GetConnectInstanceConfigResponse

" }, "GetInstanceOnboardingJobStatusRequest":{ "type":"structure", "required":["connectInstanceId"], "members":{ "connectInstanceId":{ "shape":"InstanceId", "location":"uri", "locationName":"connectInstanceId" } }, "documentation":"

GetInstanceOnboardingJobStatusRequest

" }, "GetInstanceOnboardingJobStatusResponse":{ "type":"structure", "members":{ "connectInstanceOnboardingJobStatus":{"shape":"InstanceOnboardingJobStatus"} }, "documentation":"

GetInstanceOnboardingJobStatusResponse

" }, "InstanceConfig":{ "type":"structure", "required":[ "connectInstanceId", "encryptionConfig", "serviceLinkedRoleArn" ], "members":{ "connectInstanceId":{"shape":"InstanceId"}, "encryptionConfig":{"shape":"EncryptionConfig"}, "serviceLinkedRoleArn":{"shape":"ServiceLinkedRoleArn"} }, "documentation":"

Instance config object

" }, "InstanceId":{ "type":"string", "documentation":"

Amazon Connect Instance Id

", "max":256, "min":0 }, "InstanceIdFilter":{ "type":"structure", "required":[ "operator", "value" ], "members":{ "operator":{"shape":"InstanceIdFilterOperator"}, "value":{"shape":"InstanceId"} }, "documentation":"

Connect instance identifier filter

" }, "InstanceIdFilterOperator":{ "type":"string", "documentation":"

Operators for Connect instance identifier filter

", "enum":["Eq"] }, "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"}, "failureCode":{"shape":"InstanceOnboardingJobFailureCode"}, "status":{"shape":"InstanceOnboardingJobStatusCode"} }, "documentation":"

Instance onboarding job status object

" }, "InstanceOnboardingJobStatusCode":{ "type":"string", "documentation":"

Enumeration of the possible states for instance onboarding job

", "enum":[ "IN_PROGRESS", "SUCCEEDED", "FAILED" ] }, "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":[ "message", "state" ], "members":{ "message":{"shape":"String"}, "state":{"shape":"CampaignState"}, "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 }, "ListCampaignsRequest":{ "type":"structure", "members":{ "filters":{"shape":"CampaignFilters"}, "maxResults":{"shape":"MaxResults"}, "nextToken":{"shape":"NextToken"} }, "documentation":"

ListCampaignsRequest

" }, "ListCampaignsResponse":{ "type":"structure", "members":{ "campaignSummaryList":{"shape":"CampaignSummaryList"}, "nextToken":{"shape":"NextToken"} }, "documentation":"

ListCampaignsResponse

" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"Arn", "location":"uri", "locationName":"arn" } }, "documentation":"

ListTagsForResource

" }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{"shape":"TagMap"} }, "documentation":"

ListTagsForResponse

" }, "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 }, "OutboundCallConfig":{ "type":"structure", "required":[ "connectContactFlowId", "connectQueueId" ], "members":{ "answerMachineDetectionConfig":{"shape":"AnswerMachineDetectionConfig"}, "connectContactFlowId":{"shape":"ContactFlowId"}, "connectQueueId":{"shape":"QueueId"}, "connectSourcePhoneNumber":{"shape":"SourcePhoneNumber"} }, "documentation":"

The configuration used for outbound calls.

" }, "PauseCampaignRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"

PauseCampaignRequest

" }, "PredictiveDialerConfig":{ "type":"structure", "required":["bandwidthAllocation"], "members":{ "bandwidthAllocation":{"shape":"BandwidthAllocation"} }, "documentation":"

Predictive Dialer config

" }, "ProgressiveDialerConfig":{ "type":"structure", "required":["bandwidthAllocation"], "members":{ "bandwidthAllocation":{"shape":"BandwidthAllocation"} }, "documentation":"

Progressive Dialer config

" }, "PutDialRequestBatchRequest":{ "type":"structure", "required":[ "dialRequests", "id" ], "members":{ "dialRequests":{"shape":"DialRequestList"}, "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"

PutDialRequestBatchRequest

" }, "PutDialRequestBatchResponse":{ "type":"structure", "members":{ "failedRequests":{"shape":"FailedRequestList"}, "successfulRequests":{"shape":"SuccessfulRequestList"} }, "documentation":"

PutDialRequestBatchResponse

" }, "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 }, "ResumeCampaignRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"

ResumeCampaignRequest

" }, "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 }, "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":"

StartCampaignRequest

" }, "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":"

StopCampaignRequest

" }, "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 }, "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":"

Tag key.

", "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":"

TagResourceRequest

" }, "TagValue":{ "type":"string", "documentation":"

Tag value.

", "max":256, "min":0 }, "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} }, "TimeStamp":{ "type":"timestamp", "documentation":"

Timestamp with no UTC offset or timezone

", "timestampFormat":"iso8601" }, "UntagResourceRequest":{ "type":"structure", "required":[ "arn", "tagKeys" ], "members":{ "arn":{ "shape":"Arn", "location":"uri", "locationName":"arn" }, "tagKeys":{ "shape":"TagKeyList", "location":"querystring", "locationName":"tagKeys" } }, "documentation":"

UntagResourceRequest

" }, "UpdateCampaignDialerConfigRequest":{ "type":"structure", "required":[ "dialerConfig", "id" ], "members":{ "dialerConfig":{"shape":"DialerConfig"}, "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"

UpdateCampaignDialerConfigRequest

" }, "UpdateCampaignNameRequest":{ "type":"structure", "required":[ "id", "name" ], "members":{ "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" }, "name":{"shape":"CampaignName"} }, "documentation":"

UpdateCampaignNameRequest

" }, "UpdateCampaignOutboundCallConfigRequest":{ "type":"structure", "required":["id"], "members":{ "answerMachineDetectionConfig":{"shape":"AnswerMachineDetectionConfig"}, "connectContactFlowId":{"shape":"ContactFlowId"}, "connectSourcePhoneNumber":{"shape":"SourcePhoneNumber"}, "id":{ "shape":"CampaignId", "location":"uri", "locationName":"id" } }, "documentation":"

UpdateCampaignOutboundCallConfigRequest

" }, "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 }, "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.

" }