Skip to content

Connectcampaigns Classes

AgentlessDialerConfig

dialingCapacity

  • Type: typing.Optional[float]

AnswerMachineDetectionConfig

enableAnswerMachineDetection

  • Type:
  • Required: Yes

awaitAnswerMachinePrompt

  • Type: typing.Optional[bool]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

Campaign

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

connectInstanceId

  • Type:
  • Required: Yes

dialerConfig

  • Type:
  • Required: Yes

outboundCallConfig

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CampaignFilters

instanceIdFilter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.InstanceIdFilter]

CampaignSummary

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

connectInstanceId

  • Type:
  • Required: Yes

CreateCampaignRequest

name

  • Type:
  • Required: Yes

connectInstanceId

  • Type:
  • Required: Yes

dialerConfig

  • Type:
  • Required: Yes

outboundCallConfig

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateCampaignResponse

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteCampaignRequest

id

  • Type:
  • Required: Yes

DeleteConnectInstanceConfigRequest

connectInstanceId

  • Type:
  • Required: Yes

DeleteInstanceOnboardingJobRequest

connectInstanceId

  • Type:
  • Required: Yes

DescribeCampaignRequest

id

  • Type:
  • Required: Yes

DescribeCampaignResponse

campaign

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DialRequest

clientToken

  • Type:
  • Required: Yes

phoneNumber

  • Type:
  • Required: Yes

expirationTime

  • Type: typing.Union[datetime.datetime, str]
  • Required: Yes

attributes

  • Type: typing.Dict[str, str]
  • Required: Yes

DialerConfig

progressiveDialerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.ProgressiveDialerConfig]

predictiveDialerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.PredictiveDialerConfig]

agentlessDialerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.AgentlessDialerConfig]

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

EncryptionConfig

enabled

  • Type:
  • Required: Yes

encryptionType

  • Type: typing.Optional[typing.Literal['KMS']]

keyArn

  • Type: typing.Optional[str]

FailedCampaignStateResponse

campaignId

  • Type: typing.Optional[str]

failureCode

  • Type: typing.Optional[typing.Literal['ResourceNotFound', 'UnknownError']]

FailedRequest

clientToken

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

failureCode

  • Type: typing.Optional[typing.Literal['InvalidInput', 'RequestThrottled', 'UnknownError']]

GetCampaignStateBatchRequest

campaignIds

  • Type: typing.List[str]
  • Required: Yes

GetCampaignStateBatchResponse

successfulRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.SuccessfulCampaignStateResponse]
  • Required: Yes

failedRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.FailedCampaignStateResponse]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCampaignStateRequest

id

  • Type:
  • Required: Yes

GetCampaignStateResponse

state

  • Type: typing.Literal['Failed', 'Initialized', 'Paused', 'Running', 'Stopped']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetConnectInstanceConfigRequest

connectInstanceId

  • Type:
  • Required: Yes

GetConnectInstanceConfigResponse

connectInstanceConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetInstanceOnboardingJobStatusRequest

connectInstanceId

  • Type:
  • Required: Yes

GetInstanceOnboardingJobStatusResponse

connectInstanceOnboardingJobStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

InstanceConfig

connectInstanceId

  • Type:
  • Required: Yes

serviceLinkedRoleArn

  • Type:
  • Required: Yes

encryptionConfig

  • Type:
  • Required: Yes

InstanceIdFilter

value

  • Type:
  • Required: Yes

operator

  • Type: typing.Literal['Eq']
  • Required: Yes

InstanceOnboardingJobStatus

connectInstanceId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['FAILED', 'IN_PROGRESS', 'SUCCEEDED']
  • Required: Yes

failureCode

  • Type: typing.Optional[typing.Literal['EVENT_BRIDGE_ACCESS_DENIED', 'EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED', 'IAM_ACCESS_DENIED', 'INTERNAL_FAILURE', 'KMS_ACCESS_DENIED', 'KMS_KEY_NOT_FOUND']]

ListCampaignsRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

filters

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.CampaignFilters]

ListCampaignsRequestPaginate

filters

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.CampaignFilters]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.PaginatorConfig]

ListCampaignsResponse

campaignSummaryList

  • Type: typing.List[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.CampaignSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

arn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

OutboundCallConfig

connectContactFlowId

  • Type:
  • Required: Yes

connectSourcePhoneNumber

  • Type: typing.Optional[str]

connectQueueId

  • Type: typing.Optional[str]

answerMachineDetectionConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.AnswerMachineDetectionConfig]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PauseCampaignRequest

id

  • Type:
  • Required: Yes

PredictiveDialerConfig

bandwidthAllocation

  • Type:
  • Required: Yes

dialingCapacity

  • Type: typing.Optional[float]

ProgressiveDialerConfig

bandwidthAllocation

  • Type:
  • Required: Yes

dialingCapacity

  • Type: typing.Optional[float]

PutDialRequestBatchRequest

id

  • Type:
  • Required: Yes

dialRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.DialRequest]
  • Required: Yes

PutDialRequestBatchResponse

successfulRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.SuccessfulRequest]
  • Required: Yes

failedRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.FailedRequest]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

ResumeCampaignRequest

id

  • Type:
  • Required: Yes

StartCampaignRequest

id

  • Type:
  • Required: Yes

StartInstanceOnboardingJobRequest

connectInstanceId

  • Type:
  • Required: Yes

encryptionConfig

  • Type:
  • Required: Yes

StartInstanceOnboardingJobResponse

connectInstanceOnboardingJobStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopCampaignRequest

id

  • Type:
  • Required: Yes

SuccessfulCampaignStateResponse

campaignId

  • Type: typing.Optional[str]

state

  • Type: typing.Optional[typing.Literal['Failed', 'Initialized', 'Paused', 'Running', 'Stopped']]

SuccessfulRequest

clientToken

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

TagResourceRequest

arn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

UntagResourceRequest

arn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateCampaignDialerConfigRequest

id

  • Type:
  • Required: Yes

dialerConfig

  • Type:
  • Required: Yes

UpdateCampaignNameRequest

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

UpdateCampaignOutboundCallConfigRequest

id

  • Type:
  • Required: Yes

connectContactFlowId

  • Type: typing.Optional[str]

connectSourcePhoneNumber

  • Type: typing.Optional[str]

answerMachineDetectionConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns.connectcampaigns_classes.AnswerMachineDetectionConfig]