Provide APIs to create and manage Amazon Connect Campaigns.
', 'operations' => [ 'CreateCampaign' => 'Creates a campaign for the specified Amazon Connect account. This API is idempotent.
', 'DeleteCampaign' => 'Deletes a campaign from the specified Amazon Connect account.
', 'DeleteConnectInstanceConfig' => 'Deletes a connect instance config from the specified AWS account.
', 'DeleteInstanceOnboardingJob' => 'Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
', 'DescribeCampaign' => 'Describes the specific campaign.
', 'GetCampaignState' => 'Get state of a campaign for the specified Amazon Connect account.
', 'GetCampaignStateBatch' => 'Get state of campaigns for the specified Amazon Connect account.
', 'GetConnectInstanceConfig' => 'Get the specific Connect instance config.
', 'GetInstanceOnboardingJobStatus' => 'Get the specific instance onboarding job status.
', 'ListCampaigns' => 'Provides summary information about the campaigns under the specified Amazon Connect account.
', 'ListTagsForResource' => 'List tags for a resource.
', 'PauseCampaign' => 'Pauses a campaign for the specified Amazon Connect account.
', 'PutDialRequestBatch' => 'Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
', 'ResumeCampaign' => 'Stops a campaign for the specified Amazon Connect account.
', 'StartCampaign' => 'Starts a campaign for the specified Amazon Connect account.
', 'StartInstanceOnboardingJob' => 'Onboard the specific Amazon Connect instance to Connect Campaigns.
', 'StopCampaign' => 'Stops a campaign for the specified Amazon Connect account.
', 'TagResource' => 'Tag a resource.
', 'UntagResource' => 'Untag a resource.
', 'UpdateCampaignDialerConfig' => 'Updates the dialer config of a campaign. This API is idempotent.
', 'UpdateCampaignName' => 'Updates the name of a campaign. This API is idempotent.
', 'UpdateCampaignOutboundCallConfig' => 'Updates the outbound call config of a campaign. This API is idempotent.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You do not have sufficient access to perform this action.
', 'refs' => [], ], 'AnswerMachineDetectionConfig' => [ 'base' => 'Answering Machine Detection config
', 'refs' => [ 'OutboundCallConfig$answerMachineDetectionConfig' => NULL, 'UpdateCampaignOutboundCallConfigRequest$answerMachineDetectionConfig' => NULL, ], ], 'Arn' => [ 'base' => 'Arn
', 'refs' => [ 'ListTagsForResourceRequest$arn' => NULL, 'TagResourceRequest$arn' => NULL, 'UntagResourceRequest$arn' => NULL, ], ], 'AttributeName' => [ 'base' => 'The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.
', 'refs' => [ 'Attributes$key' => NULL, ], ], 'AttributeValue' => [ 'base' => 'The value of the attribute.
', 'refs' => [ 'Attributes$value' => NULL, ], ], 'Attributes' => [ 'base' => '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.
', 'refs' => [ 'DialRequest$attributes' => NULL, ], ], 'BandwidthAllocation' => [ 'base' => 'The bandwidth allocation of a queue resource.
', 'refs' => [ 'PredictiveDialerConfig$bandwidthAllocation' => NULL, 'ProgressiveDialerConfig$bandwidthAllocation' => NULL, ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AnswerMachineDetectionConfig$enableAnswerMachineDetection' => 'Enable or disable answering machine detection
', ], ], 'Campaign' => [ 'base' => 'An Amazon Connect campaign.
', 'refs' => [ 'DescribeCampaignResponse$campaign' => NULL, ], ], 'CampaignArn' => [ 'base' => 'The resource name of an Amazon Connect campaign.
', 'refs' => [ 'Campaign$arn' => NULL, 'CampaignSummary$arn' => NULL, 'CreateCampaignResponse$arn' => NULL, ], ], 'CampaignFilters' => [ 'base' => 'Filter model by type
', 'refs' => [ 'ListCampaignsRequest$filters' => NULL, ], ], 'CampaignId' => [ 'base' => 'Identifier representing a Campaign
', 'refs' => [ 'Campaign$id' => NULL, 'CampaignSummary$id' => NULL, 'CreateCampaignResponse$id' => NULL, 'DeleteCampaignRequest$id' => NULL, 'DescribeCampaignRequest$id' => NULL, 'FailedCampaignStateResponse$campaignId' => NULL, 'GetCampaignStateBatchRequestCampaignIdsList$member' => NULL, 'GetCampaignStateRequest$id' => NULL, 'PauseCampaignRequest$id' => NULL, 'PutDialRequestBatchRequest$id' => NULL, 'ResumeCampaignRequest$id' => NULL, 'StartCampaignRequest$id' => NULL, 'StopCampaignRequest$id' => NULL, 'SuccessfulCampaignStateResponse$campaignId' => NULL, 'UpdateCampaignDialerConfigRequest$id' => NULL, 'UpdateCampaignNameRequest$id' => NULL, 'UpdateCampaignOutboundCallConfigRequest$id' => NULL, ], ], 'CampaignName' => [ 'base' => 'The name of an Amazon Connect Campaign name.
', 'refs' => [ 'Campaign$name' => NULL, 'CampaignSummary$name' => NULL, 'CreateCampaignRequest$name' => NULL, 'UpdateCampaignNameRequest$name' => NULL, ], ], 'CampaignState' => [ 'base' => 'State of a campaign
', 'refs' => [ 'GetCampaignStateResponse$state' => NULL, 'InvalidCampaignStateException$state' => NULL, 'SuccessfulCampaignStateResponse$state' => NULL, ], ], 'CampaignSummary' => [ 'base' => 'An Amazon Connect campaign summary.
', 'refs' => [ 'CampaignSummaryList$member' => NULL, ], ], 'CampaignSummaryList' => [ 'base' => 'A list of Amazon Connect campaigns.
', 'refs' => [ 'ListCampaignsResponse$campaignSummaryList' => NULL, ], ], 'ClientToken' => [ 'base' => 'Client provided parameter used for idempotency. Its value must be unique for each request.
', 'refs' => [ 'DialRequest$clientToken' => NULL, 'FailedRequest$clientToken' => NULL, 'SuccessfulRequest$clientToken' => NULL, ], ], 'ConflictException' => [ 'base' => 'The request could not be processed because of conflict in the current state of the resource.
', 'refs' => [], ], 'ContactFlowId' => [ 'base' => 'The identifier of the contact flow for the outbound call.
', 'refs' => [ 'OutboundCallConfig$connectContactFlowId' => NULL, 'UpdateCampaignOutboundCallConfigRequest$connectContactFlowId' => NULL, ], ], 'CreateCampaignRequest' => [ 'base' => 'The request for Create Campaign API.
', 'refs' => [], ], 'CreateCampaignResponse' => [ 'base' => 'The response for Create Campaign API
', 'refs' => [], ], 'DeleteCampaignRequest' => [ 'base' => 'DeleteCampaignRequest
', 'refs' => [], ], 'DeleteConnectInstanceConfigRequest' => [ 'base' => 'DeleteCampaignRequest
', 'refs' => [], ], 'DeleteInstanceOnboardingJobRequest' => [ 'base' => 'The request for DeleteInstanceOnboardingJob API.
', 'refs' => [], ], 'DescribeCampaignRequest' => [ 'base' => 'DescribeCampaignRequests
', 'refs' => [], ], 'DescribeCampaignResponse' => [ 'base' => 'DescribeCampaignResponse
', 'refs' => [], ], 'DestinationPhoneNumber' => [ 'base' => 'The phone number of the customer, in E.164 format.
', 'refs' => [ 'DialRequest$phoneNumber' => NULL, ], ], 'DialRequest' => [ 'base' => 'A dial request for a campaign.
', 'refs' => [ 'DialRequestList$member' => NULL, ], ], 'DialRequestId' => [ 'base' => 'Identifier representing a Dial request
', 'refs' => [ 'FailedRequest$id' => NULL, 'SuccessfulRequest$id' => NULL, ], ], 'DialRequestList' => [ 'base' => 'A list of dial requests.
', 'refs' => [ 'PutDialRequestBatchRequest$dialRequests' => NULL, ], ], 'DialerConfig' => [ 'base' => 'The possible types of dialer config parameters
', 'refs' => [ 'Campaign$dialerConfig' => NULL, 'CreateCampaignRequest$dialerConfig' => NULL, 'UpdateCampaignDialerConfigRequest$dialerConfig' => NULL, ], ], 'Enabled' => [ 'base' => 'Boolean to indicate if custom encryption has been enabled.
', 'refs' => [ 'EncryptionConfig$enabled' => NULL, ], ], 'EncryptionConfig' => [ 'base' => '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
', 'refs' => [ 'InstanceConfig$encryptionConfig' => NULL, 'StartInstanceOnboardingJobRequest$encryptionConfig' => NULL, ], ], 'EncryptionKey' => [ 'base' => 'KMS key id/arn for encryption config.
', 'refs' => [ 'EncryptionConfig$keyArn' => NULL, ], ], 'EncryptionType' => [ 'base' => 'Server-side encryption type.
', 'refs' => [ 'EncryptionConfig$encryptionType' => NULL, ], ], 'FailedCampaignStateResponse' => [ 'base' => 'Failed response of campaign state
', 'refs' => [ 'FailedCampaignStateResponseList$member' => NULL, ], ], 'FailedCampaignStateResponseList' => [ 'base' => 'List of failed requests of campaign state
', 'refs' => [ 'GetCampaignStateBatchResponse$failedRequests' => NULL, ], ], 'FailedRequest' => [ 'base' => 'A failed request identified by the unique client token.
', 'refs' => [ 'FailedRequestList$member' => NULL, ], ], 'FailedRequestList' => [ 'base' => 'A list of failed requests.
', 'refs' => [ 'PutDialRequestBatchResponse$failedRequests' => NULL, ], ], 'FailureCode' => [ 'base' => 'A predefined code indicating the error that caused the failure.
', 'refs' => [ 'FailedRequest$failureCode' => NULL, ], ], 'GetCampaignStateBatchFailureCode' => [ 'base' => 'A predefined code indicating the error that caused the failure in getting state of campaigns
', 'refs' => [ 'FailedCampaignStateResponse$failureCode' => NULL, ], ], 'GetCampaignStateBatchRequest' => [ 'base' => 'GetCampaignStateBatchRequest
', 'refs' => [], ], 'GetCampaignStateBatchRequestCampaignIdsList' => [ 'base' => 'List of CampaignId
', 'refs' => [ 'GetCampaignStateBatchRequest$campaignIds' => NULL, ], ], 'GetCampaignStateBatchResponse' => [ 'base' => 'GetCampaignStateBatchResponse
', 'refs' => [], ], 'GetCampaignStateRequest' => [ 'base' => 'GetCampaignStateRequest
', 'refs' => [], ], 'GetCampaignStateResponse' => [ 'base' => 'GetCampaignStateResponse
', 'refs' => [], ], 'GetConnectInstanceConfigRequest' => [ 'base' => 'GetConnectInstanceConfigRequest
', 'refs' => [], ], 'GetConnectInstanceConfigResponse' => [ 'base' => 'GetConnectInstanceConfigResponse
', 'refs' => [], ], 'GetInstanceOnboardingJobStatusRequest' => [ 'base' => 'GetInstanceOnboardingJobStatusRequest
', 'refs' => [], ], 'GetInstanceOnboardingJobStatusResponse' => [ 'base' => 'GetInstanceOnboardingJobStatusResponse
', 'refs' => [], ], 'InstanceConfig' => [ 'base' => 'Instance config object
', 'refs' => [ 'GetConnectInstanceConfigResponse$connectInstanceConfig' => NULL, ], ], 'InstanceId' => [ 'base' => 'Amazon Connect Instance Id
', 'refs' => [ 'Campaign$connectInstanceId' => NULL, 'CampaignSummary$connectInstanceId' => NULL, 'CreateCampaignRequest$connectInstanceId' => NULL, 'DeleteConnectInstanceConfigRequest$connectInstanceId' => NULL, 'DeleteInstanceOnboardingJobRequest$connectInstanceId' => NULL, 'GetConnectInstanceConfigRequest$connectInstanceId' => NULL, 'GetInstanceOnboardingJobStatusRequest$connectInstanceId' => NULL, 'InstanceConfig$connectInstanceId' => NULL, 'InstanceIdFilter$value' => NULL, 'InstanceOnboardingJobStatus$connectInstanceId' => NULL, 'StartInstanceOnboardingJobRequest$connectInstanceId' => NULL, ], ], 'InstanceIdFilter' => [ 'base' => 'Connect instance identifier filter
', 'refs' => [ 'CampaignFilters$instanceIdFilter' => NULL, ], ], 'InstanceIdFilterOperator' => [ 'base' => 'Operators for Connect instance identifier filter
', 'refs' => [ 'InstanceIdFilter$operator' => NULL, ], ], 'InstanceOnboardingJobFailureCode' => [ 'base' => 'Enumeration of the possible failure codes for instance onboarding job
', 'refs' => [ 'InstanceOnboardingJobStatus$failureCode' => NULL, ], ], 'InstanceOnboardingJobStatus' => [ 'base' => 'Instance onboarding job status object
', 'refs' => [ 'GetInstanceOnboardingJobStatusResponse$connectInstanceOnboardingJobStatus' => NULL, 'StartInstanceOnboardingJobResponse$connectInstanceOnboardingJobStatus' => NULL, ], ], 'InstanceOnboardingJobStatusCode' => [ 'base' => 'Enumeration of the possible states for instance onboarding job
', 'refs' => [ 'InstanceOnboardingJobStatus$status' => NULL, ], ], 'InternalServerException' => [ 'base' => 'Request processing failed because of an error or failure with the service.
', 'refs' => [], ], 'InvalidCampaignStateException' => [ 'base' => 'The request could not be processed because of conflict in the current state of the campaign.
', 'refs' => [], ], 'InvalidStateException' => [ 'base' => 'The request could not be processed because of conflict in the current state.
', 'refs' => [], ], 'ListCampaignsRequest' => [ 'base' => 'ListCampaignsRequest
', 'refs' => [], ], 'ListCampaignsResponse' => [ 'base' => 'ListCampaignsResponse
', 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => 'ListTagsForResource
', 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => 'ListTagsForResponse
', 'refs' => [], ], 'MaxResults' => [ 'base' => 'The maximum number of results to return per page.
', 'refs' => [ 'ListCampaignsRequest$maxResults' => NULL, ], ], 'NextToken' => [ 'base' => 'The token for the next set of results.
', 'refs' => [ 'ListCampaignsRequest$nextToken' => NULL, 'ListCampaignsResponse$nextToken' => NULL, ], ], 'OutboundCallConfig' => [ 'base' => 'The configuration used for outbound calls.
', 'refs' => [ 'Campaign$outboundCallConfig' => NULL, 'CreateCampaignRequest$outboundCallConfig' => NULL, ], ], 'PauseCampaignRequest' => [ 'base' => 'PauseCampaignRequest
', 'refs' => [], ], 'PredictiveDialerConfig' => [ 'base' => 'Predictive Dialer config
', 'refs' => [ 'DialerConfig$predictiveDialerConfig' => NULL, ], ], 'ProgressiveDialerConfig' => [ 'base' => 'Progressive Dialer config
', 'refs' => [ 'DialerConfig$progressiveDialerConfig' => NULL, ], ], 'PutDialRequestBatchRequest' => [ 'base' => 'PutDialRequestBatchRequest
', 'refs' => [], ], 'PutDialRequestBatchResponse' => [ 'base' => 'PutDialRequestBatchResponse
', 'refs' => [], ], 'QueueId' => [ 'base' => '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.
', 'refs' => [ 'OutboundCallConfig$connectQueueId' => NULL, ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource was not found.
', 'refs' => [], ], 'ResumeCampaignRequest' => [ 'base' => 'ResumeCampaignRequest
', 'refs' => [], ], 'ServiceLinkedRoleArn' => [ 'base' => 'Service linked role arn
', 'refs' => [ 'InstanceConfig$serviceLinkedRoleArn' => NULL, ], ], 'ServiceQuotaExceededException' => [ 'base' => 'Request would cause a service quota to be exceeded.
', 'refs' => [], ], 'SourcePhoneNumber' => [ 'base' => '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.
', 'refs' => [ 'OutboundCallConfig$connectSourcePhoneNumber' => NULL, 'UpdateCampaignOutboundCallConfigRequest$connectSourcePhoneNumber' => NULL, ], ], 'StartCampaignRequest' => [ 'base' => 'StartCampaignRequest
', 'refs' => [], ], 'StartInstanceOnboardingJobRequest' => [ 'base' => 'The request for StartInstanceOnboardingJob API.
', 'refs' => [], ], 'StartInstanceOnboardingJobResponse' => [ 'base' => 'The response for StartInstanceOnboardingJob API.
', 'refs' => [], ], 'StopCampaignRequest' => [ 'base' => 'StopCampaignRequest
', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'InternalServerException$message' => NULL, 'InvalidCampaignStateException$message' => NULL, 'InvalidStateException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'SuccessfulCampaignStateResponse' => [ 'base' => 'Successful response of campaign state
', 'refs' => [ 'SuccessfulCampaignStateResponseList$member' => NULL, ], ], 'SuccessfulCampaignStateResponseList' => [ 'base' => 'List of successful response of campaign state
', 'refs' => [ 'GetCampaignStateBatchResponse$successfulRequests' => NULL, ], ], 'SuccessfulRequest' => [ 'base' => 'A successful request identified by the unique client token.
', 'refs' => [ 'SuccessfulRequestList$member' => NULL, ], ], 'SuccessfulRequestList' => [ 'base' => 'A list of successful requests identified by the unique client token.
', 'refs' => [ 'PutDialRequestBatchResponse$successfulRequests' => NULL, ], ], 'TagKey' => [ 'base' => 'Tag key.
', 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => 'List of tag keys.
', 'refs' => [ 'UntagResourceRequest$tagKeys' => NULL, ], ], 'TagMap' => [ 'base' => 'Tag map with key and value.
', 'refs' => [ 'Campaign$tags' => NULL, 'CreateCampaignRequest$tags' => NULL, 'CreateCampaignResponse$tags' => NULL, 'ListTagsForResourceResponse$tags' => NULL, 'TagResourceRequest$tags' => NULL, ], ], 'TagResourceRequest' => [ 'base' => 'TagResourceRequest
', 'refs' => [], ], 'TagValue' => [ 'base' => 'Tag value.
', 'refs' => [ 'TagMap$value' => NULL, ], ], 'ThrottlingException' => [ 'base' => 'The request was denied due to request throttling.
', 'refs' => [], ], 'TimeStamp' => [ 'base' => 'Timestamp with no UTC offset or timezone
', 'refs' => [ 'DialRequest$expirationTime' => NULL, ], ], 'UntagResourceRequest' => [ 'base' => 'UntagResourceRequest
', 'refs' => [], ], 'UpdateCampaignDialerConfigRequest' => [ 'base' => 'UpdateCampaignDialerConfigRequest
', 'refs' => [], ], 'UpdateCampaignNameRequest' => [ 'base' => 'UpdateCampaignNameRequest
', 'refs' => [], ], 'UpdateCampaignOutboundCallConfigRequest' => [ 'base' => 'UpdateCampaignOutboundCallConfigRequest
', 'refs' => [], ], 'ValidationException' => [ 'base' => 'The input fails to satisfy the constraints specified by an AWS service.
', 'refs' => [], ], 'XAmazonErrorType' => [ 'base' => 'A header that defines the error encountered while processing the request.
', 'refs' => [ 'AccessDeniedException$xAmzErrorType' => NULL, 'ConflictException$xAmzErrorType' => NULL, 'InternalServerException$xAmzErrorType' => NULL, 'InvalidCampaignStateException$xAmzErrorType' => NULL, 'InvalidStateException$xAmzErrorType' => NULL, 'ResourceNotFoundException$xAmzErrorType' => NULL, 'ServiceQuotaExceededException$xAmzErrorType' => NULL, 'ThrottlingException$xAmzErrorType' => NULL, 'ValidationException$xAmzErrorType' => NULL, ], ], ],];