Skip to content

Connectcampaigns Classes

AgentlessDialerConfigTypeDef

dialingCapacity

  • Type: typing.Optional[float]

AnswerMachineDetectionConfigTypeDef

enableAnswerMachineDetection

  • Type:
  • Required: Yes

awaitAnswerMachinePrompt

  • Type: typing.Optional[bool]

BaseValidatorModel

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

CampaignFiltersTypeDef

instanceIdFilter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns_classes.InstanceIdFilterTypeDef]

CampaignSummaryTypeDef

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

connectInstanceId

  • Type:
  • Required: Yes

CampaignTypeDef

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]]

CreateCampaignRequestRequestTypeDef

name

  • Type:
  • Required: Yes

connectInstanceId

  • Type:
  • Required: Yes

dialerConfig

  • Type:
  • Required: Yes

outboundCallConfig

  • Type:
  • Required: Yes

tags

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

CreateCampaignResponseTypeDef

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

tags

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

ResponseMetadata

  • Type:
  • Required: Yes

DeleteCampaignRequestRequestTypeDef

id

  • Type:
  • Required: Yes

DeleteConnectInstanceConfigRequestRequestTypeDef

connectInstanceId

  • Type:
  • Required: Yes

DeleteInstanceOnboardingJobRequestRequestTypeDef

connectInstanceId

  • Type:
  • Required: Yes

DescribeCampaignRequestRequestTypeDef

id

  • Type:
  • Required: Yes

DescribeCampaignResponseTypeDef

campaign

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DialRequestTypeDef

clientToken

  • Type:
  • Required: Yes

phoneNumber

  • Type:
  • Required: Yes

expirationTime

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

attributes

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

DialerConfigTypeDef

progressiveDialerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns_classes.ProgressiveDialerConfigTypeDef]

predictiveDialerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns_classes.PredictiveDialerConfigTypeDef]

agentlessDialerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns_classes.AgentlessDialerConfigTypeDef]

EmptyResponseMetadataTypeDef

ResponseMetadata

  • Type:
  • Required: Yes

EncryptionConfigTypeDef

enabled

  • Type:
  • Required: Yes

encryptionType

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

keyArn

  • Type: typing.Optional[str]

FailedCampaignStateResponseTypeDef

campaignId

  • Type: typing.Optional[str]

failureCode

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

FailedRequestTypeDef

clientToken

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

failureCode

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

GetCampaignStateBatchRequestRequestTypeDef

campaignIds

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

GetCampaignStateBatchResponseTypeDef

successfulRequests

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

failedRequests

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

ResponseMetadata

  • Type:
  • Required: Yes

GetCampaignStateRequestRequestTypeDef

id

  • Type:
  • Required: Yes

GetCampaignStateResponseTypeDef

state

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

ResponseMetadata

  • Type:
  • Required: Yes

GetConnectInstanceConfigRequestRequestTypeDef

connectInstanceId

  • Type:
  • Required: Yes

GetConnectInstanceConfigResponseTypeDef

connectInstanceConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetInstanceOnboardingJobStatusRequestRequestTypeDef

connectInstanceId

  • Type:
  • Required: Yes

GetInstanceOnboardingJobStatusResponseTypeDef

connectInstanceOnboardingJobStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

InstanceConfigTypeDef

connectInstanceId

  • Type:
  • Required: Yes

serviceLinkedRoleArn

  • Type:
  • Required: Yes

encryptionConfig

  • Type:
  • Required: Yes

InstanceIdFilterTypeDef

value

  • Type:
  • Required: Yes

operator

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

InstanceOnboardingJobStatusTypeDef

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']]

ListCampaignsRequestListCampaignsPaginateTypeDef

filters

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns_classes.CampaignFiltersTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns_classes.PaginatorConfigTypeDef]

ListCampaignsRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

filters

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns_classes.CampaignFiltersTypeDef]

ListCampaignsResponseTypeDef

nextToken

  • Type:
  • Required: Yes

campaignSummaryList

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

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

tags

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

ResponseMetadata

  • Type:
  • Required: Yes

OutboundCallConfigTypeDef

connectContactFlowId

  • Type:
  • Required: Yes

connectSourcePhoneNumber

  • Type: typing.Optional[str]

connectQueueId

  • Type: typing.Optional[str]

answerMachineDetectionConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns_classes.AnswerMachineDetectionConfigTypeDef]

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PauseCampaignRequestRequestTypeDef

id

  • Type:
  • Required: Yes

PredictiveDialerConfigTypeDef

bandwidthAllocation

  • Type:
  • Required: Yes

dialingCapacity

  • Type: typing.Optional[float]

ProgressiveDialerConfigTypeDef

bandwidthAllocation

  • Type:
  • Required: Yes

dialingCapacity

  • Type: typing.Optional[float]

PutDialRequestBatchRequestRequestTypeDef

id

  • Type:
  • Required: Yes

dialRequests

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.connectcampaigns_classes.DialRequestTypeDef]
  • Required: Yes

PutDialRequestBatchResponseTypeDef

successfulRequests

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

failedRequests

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

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadataTypeDef

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]

ResumeCampaignRequestRequestTypeDef

id

  • Type:
  • Required: Yes

StartCampaignRequestRequestTypeDef

id

  • Type:
  • Required: Yes

StartInstanceOnboardingJobRequestRequestTypeDef

connectInstanceId

  • Type:
  • Required: Yes

encryptionConfig

  • Type:
  • Required: Yes

StartInstanceOnboardingJobResponseTypeDef

connectInstanceOnboardingJobStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopCampaignRequestRequestTypeDef

id

  • Type:
  • Required: Yes

SuccessfulCampaignStateResponseTypeDef

campaignId

  • Type: typing.Optional[str]

state

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

SuccessfulRequestTypeDef

clientToken

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

TagResourceRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

tags

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

UntagResourceRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

tagKeys

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

UpdateCampaignDialerConfigRequestRequestTypeDef

id

  • Type:
  • Required: Yes

dialerConfig

  • Type:
  • Required: Yes

UpdateCampaignNameRequestRequestTypeDef

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

UpdateCampaignOutboundCallConfigRequestRequestTypeDef

id

  • Type:
  • Required: Yes

connectContactFlowId

  • Type: typing.Optional[str]

connectSourcePhoneNumber

  • Type: typing.Optional[str]

answerMachineDetectionConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.connectcampaigns_classes.AnswerMachineDetectionConfigTypeDef]