Skip to content

Type definitions#

Index > ConnectCampaignService > Type definitions

Auto-generated documentation for ConnectCampaignService type annotations stubs module mypy-boto3-connectcampaigns.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AgentlessDialerConfigTypeDef#

# AgentlessDialerConfigTypeDef definition

class AgentlessDialerConfigTypeDef(TypedDict):
    dialingCapacity: NotRequired[float],

AnswerMachineDetectionConfigTypeDef#

# AnswerMachineDetectionConfigTypeDef definition

class AnswerMachineDetectionConfigTypeDef(TypedDict):
    enableAnswerMachineDetection: bool,

InstanceIdFilterTypeDef#

# InstanceIdFilterTypeDef definition

class InstanceIdFilterTypeDef(TypedDict):
    value: str,
    operator: InstanceIdFilterOperatorType,  # (1)
  1. See InstanceIdFilterOperatorType

CampaignSummaryTypeDef#

# CampaignSummaryTypeDef definition

class CampaignSummaryTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    connectInstanceId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DeleteCampaignRequestRequestTypeDef#

# DeleteCampaignRequestRequestTypeDef definition

class DeleteCampaignRequestRequestTypeDef(TypedDict):
    id: str,

DeleteConnectInstanceConfigRequestRequestTypeDef#

# DeleteConnectInstanceConfigRequestRequestTypeDef definition

class DeleteConnectInstanceConfigRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,

DeleteInstanceOnboardingJobRequestRequestTypeDef#

# DeleteInstanceOnboardingJobRequestRequestTypeDef definition

class DeleteInstanceOnboardingJobRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,

DescribeCampaignRequestRequestTypeDef#

# DescribeCampaignRequestRequestTypeDef definition

class DescribeCampaignRequestRequestTypeDef(TypedDict):
    id: str,

PredictiveDialerConfigTypeDef#

# PredictiveDialerConfigTypeDef definition

class PredictiveDialerConfigTypeDef(TypedDict):
    bandwidthAllocation: float,
    dialingCapacity: NotRequired[float],

ProgressiveDialerConfigTypeDef#

# ProgressiveDialerConfigTypeDef definition

class ProgressiveDialerConfigTypeDef(TypedDict):
    bandwidthAllocation: float,
    dialingCapacity: NotRequired[float],

EncryptionConfigTypeDef#

# EncryptionConfigTypeDef definition

class EncryptionConfigTypeDef(TypedDict):
    enabled: bool,
    encryptionType: NotRequired[EncryptionTypeType],  # (1)
    keyArn: NotRequired[str],
  1. See EncryptionTypeType

FailedCampaignStateResponseTypeDef#

# FailedCampaignStateResponseTypeDef definition

class FailedCampaignStateResponseTypeDef(TypedDict):
    campaignId: NotRequired[str],
    failureCode: NotRequired[GetCampaignStateBatchFailureCodeType],  # (1)
  1. See GetCampaignStateBatchFailureCodeType

FailedRequestTypeDef#

# FailedRequestTypeDef definition

class FailedRequestTypeDef(TypedDict):
    clientToken: NotRequired[str],
    id: NotRequired[str],
    failureCode: NotRequired[FailureCodeType],  # (1)
  1. See FailureCodeType

GetCampaignStateBatchRequestRequestTypeDef#

# GetCampaignStateBatchRequestRequestTypeDef definition

class GetCampaignStateBatchRequestRequestTypeDef(TypedDict):
    campaignIds: Sequence[str],

SuccessfulCampaignStateResponseTypeDef#

# SuccessfulCampaignStateResponseTypeDef definition

class SuccessfulCampaignStateResponseTypeDef(TypedDict):
    campaignId: NotRequired[str],
    state: NotRequired[CampaignStateType],  # (1)
  1. See CampaignStateType

GetCampaignStateRequestRequestTypeDef#

# GetCampaignStateRequestRequestTypeDef definition

class GetCampaignStateRequestRequestTypeDef(TypedDict):
    id: str,

GetConnectInstanceConfigRequestRequestTypeDef#

# GetConnectInstanceConfigRequestRequestTypeDef definition

class GetConnectInstanceConfigRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,

GetInstanceOnboardingJobStatusRequestRequestTypeDef#

# GetInstanceOnboardingJobStatusRequestRequestTypeDef definition

class GetInstanceOnboardingJobStatusRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,

InstanceOnboardingJobStatusTypeDef#

# InstanceOnboardingJobStatusTypeDef definition

class InstanceOnboardingJobStatusTypeDef(TypedDict):
    connectInstanceId: str,
    status: InstanceOnboardingJobStatusCodeType,  # (1)
    failureCode: NotRequired[InstanceOnboardingJobFailureCodeType],  # (2)
  1. See InstanceOnboardingJobStatusCodeType
  2. See InstanceOnboardingJobFailureCodeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    arn: str,

PauseCampaignRequestRequestTypeDef#

# PauseCampaignRequestRequestTypeDef definition

class PauseCampaignRequestRequestTypeDef(TypedDict):
    id: str,

SuccessfulRequestTypeDef#

# SuccessfulRequestTypeDef definition

class SuccessfulRequestTypeDef(TypedDict):
    clientToken: NotRequired[str],
    id: NotRequired[str],

ResumeCampaignRequestRequestTypeDef#

# ResumeCampaignRequestRequestTypeDef definition

class ResumeCampaignRequestRequestTypeDef(TypedDict):
    id: str,

StartCampaignRequestRequestTypeDef#

# StartCampaignRequestRequestTypeDef definition

class StartCampaignRequestRequestTypeDef(TypedDict):
    id: str,

StopCampaignRequestRequestTypeDef#

# StopCampaignRequestRequestTypeDef definition

class StopCampaignRequestRequestTypeDef(TypedDict):
    id: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    arn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    arn: str,
    tagKeys: Sequence[str],

UpdateCampaignNameRequestRequestTypeDef#

# UpdateCampaignNameRequestRequestTypeDef definition

class UpdateCampaignNameRequestRequestTypeDef(TypedDict):
    id: str,
    name: str,

OutboundCallConfigTypeDef#

# OutboundCallConfigTypeDef definition

class OutboundCallConfigTypeDef(TypedDict):
    connectContactFlowId: str,
    connectSourcePhoneNumber: NotRequired[str],
    connectQueueId: NotRequired[str],
    answerMachineDetectionConfig: NotRequired[AnswerMachineDetectionConfigTypeDef],  # (1)
  1. See AnswerMachineDetectionConfigTypeDef

UpdateCampaignOutboundCallConfigRequestRequestTypeDef#

# UpdateCampaignOutboundCallConfigRequestRequestTypeDef definition

class UpdateCampaignOutboundCallConfigRequestRequestTypeDef(TypedDict):
    id: str,
    connectContactFlowId: NotRequired[str],
    connectSourcePhoneNumber: NotRequired[str],
    answerMachineDetectionConfig: NotRequired[AnswerMachineDetectionConfigTypeDef],  # (1)
  1. See AnswerMachineDetectionConfigTypeDef

CampaignFiltersTypeDef#

# CampaignFiltersTypeDef definition

class CampaignFiltersTypeDef(TypedDict):
    instanceIdFilter: NotRequired[InstanceIdFilterTypeDef],  # (1)
  1. See InstanceIdFilterTypeDef

CreateCampaignResponseTypeDef#

# CreateCampaignResponseTypeDef definition

class CreateCampaignResponseTypeDef(TypedDict):
    id: str,
    arn: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetCampaignStateResponseTypeDef#

# GetCampaignStateResponseTypeDef definition

class GetCampaignStateResponseTypeDef(TypedDict):
    state: CampaignStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CampaignStateType
  2. See ResponseMetadataTypeDef

ListCampaignsResponseTypeDef#

# ListCampaignsResponseTypeDef definition

class ListCampaignsResponseTypeDef(TypedDict):
    nextToken: str,
    campaignSummaryList: List[CampaignSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CampaignSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DialRequestTypeDef#

# DialRequestTypeDef definition

class DialRequestTypeDef(TypedDict):
    clientToken: str,
    phoneNumber: str,
    expirationTime: Union[datetime, str],
    attributes: Mapping[str, str],

DialerConfigTypeDef#

# DialerConfigTypeDef definition

class DialerConfigTypeDef(TypedDict):
    progressiveDialerConfig: NotRequired[ProgressiveDialerConfigTypeDef],  # (1)
    predictiveDialerConfig: NotRequired[PredictiveDialerConfigTypeDef],  # (2)
    agentlessDialerConfig: NotRequired[AgentlessDialerConfigTypeDef],  # (3)
  1. See ProgressiveDialerConfigTypeDef
  2. See PredictiveDialerConfigTypeDef
  3. See AgentlessDialerConfigTypeDef

InstanceConfigTypeDef#

# InstanceConfigTypeDef definition

class InstanceConfigTypeDef(TypedDict):
    connectInstanceId: str,
    serviceLinkedRoleArn: str,
    encryptionConfig: EncryptionConfigTypeDef,  # (1)
  1. See EncryptionConfigTypeDef

StartInstanceOnboardingJobRequestRequestTypeDef#

# StartInstanceOnboardingJobRequestRequestTypeDef definition

class StartInstanceOnboardingJobRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,
    encryptionConfig: EncryptionConfigTypeDef,  # (1)
  1. See EncryptionConfigTypeDef

GetCampaignStateBatchResponseTypeDef#

# GetCampaignStateBatchResponseTypeDef definition

class GetCampaignStateBatchResponseTypeDef(TypedDict):
    successfulRequests: List[SuccessfulCampaignStateResponseTypeDef],  # (1)
    failedRequests: List[FailedCampaignStateResponseTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SuccessfulCampaignStateResponseTypeDef
  2. See FailedCampaignStateResponseTypeDef
  3. See ResponseMetadataTypeDef

GetInstanceOnboardingJobStatusResponseTypeDef#

# GetInstanceOnboardingJobStatusResponseTypeDef definition

class GetInstanceOnboardingJobStatusResponseTypeDef(TypedDict):
    connectInstanceOnboardingJobStatus: InstanceOnboardingJobStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceOnboardingJobStatusTypeDef
  2. See ResponseMetadataTypeDef

StartInstanceOnboardingJobResponseTypeDef#

# StartInstanceOnboardingJobResponseTypeDef definition

class StartInstanceOnboardingJobResponseTypeDef(TypedDict):
    connectInstanceOnboardingJobStatus: InstanceOnboardingJobStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceOnboardingJobStatusTypeDef
  2. See ResponseMetadataTypeDef

PutDialRequestBatchResponseTypeDef#

# PutDialRequestBatchResponseTypeDef definition

class PutDialRequestBatchResponseTypeDef(TypedDict):
    successfulRequests: List[SuccessfulRequestTypeDef],  # (1)
    failedRequests: List[FailedRequestTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SuccessfulRequestTypeDef
  2. See FailedRequestTypeDef
  3. See ResponseMetadataTypeDef

ListCampaignsRequestListCampaignsPaginateTypeDef#

# ListCampaignsRequestListCampaignsPaginateTypeDef definition

class ListCampaignsRequestListCampaignsPaginateTypeDef(TypedDict):
    filters: NotRequired[CampaignFiltersTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See CampaignFiltersTypeDef
  2. See PaginatorConfigTypeDef

ListCampaignsRequestRequestTypeDef#

# ListCampaignsRequestRequestTypeDef definition

class ListCampaignsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    filters: NotRequired[CampaignFiltersTypeDef],  # (1)
  1. See CampaignFiltersTypeDef

PutDialRequestBatchRequestRequestTypeDef#

# PutDialRequestBatchRequestRequestTypeDef definition

class PutDialRequestBatchRequestRequestTypeDef(TypedDict):
    id: str,
    dialRequests: Sequence[DialRequestTypeDef],  # (1)
  1. See DialRequestTypeDef

CampaignTypeDef#

# CampaignTypeDef definition

class CampaignTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    connectInstanceId: str,
    dialerConfig: DialerConfigTypeDef,  # (1)
    outboundCallConfig: OutboundCallConfigTypeDef,  # (2)
    tags: NotRequired[Dict[str, str]],
  1. See DialerConfigTypeDef
  2. See OutboundCallConfigTypeDef

CreateCampaignRequestRequestTypeDef#

# CreateCampaignRequestRequestTypeDef definition

class CreateCampaignRequestRequestTypeDef(TypedDict):
    name: str,
    connectInstanceId: str,
    dialerConfig: DialerConfigTypeDef,  # (1)
    outboundCallConfig: OutboundCallConfigTypeDef,  # (2)
    tags: NotRequired[Mapping[str, str]],
  1. See DialerConfigTypeDef
  2. See OutboundCallConfigTypeDef

UpdateCampaignDialerConfigRequestRequestTypeDef#

# UpdateCampaignDialerConfigRequestRequestTypeDef definition

class UpdateCampaignDialerConfigRequestRequestTypeDef(TypedDict):
    id: str,
    dialerConfig: DialerConfigTypeDef,  # (1)
  1. See DialerConfigTypeDef

GetConnectInstanceConfigResponseTypeDef#

# GetConnectInstanceConfigResponseTypeDef definition

class GetConnectInstanceConfigResponseTypeDef(TypedDict):
    connectInstanceConfig: InstanceConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceConfigTypeDef
  2. See ResponseMetadataTypeDef

DescribeCampaignResponseTypeDef#

# DescribeCampaignResponseTypeDef definition

class DescribeCampaignResponseTypeDef(TypedDict):
    campaign: CampaignTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CampaignTypeDef
  2. See ResponseMetadataTypeDef