Skip to content

Type definitions#

Index > ConnectCampaignService > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef Union usage example

from mypy_boto3_connectcampaigns.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

AgentlessDialerConfigTypeDef#

# AgentlessDialerConfigTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import AgentlessDialerConfigTypeDef


def get_value() -> AgentlessDialerConfigTypeDef:
    return {
        "dialingCapacity": ...,
    }


# AgentlessDialerConfigTypeDef definition

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

AnswerMachineDetectionConfigTypeDef#

# AnswerMachineDetectionConfigTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import AnswerMachineDetectionConfigTypeDef


def get_value() -> AnswerMachineDetectionConfigTypeDef:
    return {
        "enableAnswerMachineDetection": ...,
    }


# AnswerMachineDetectionConfigTypeDef definition

class AnswerMachineDetectionConfigTypeDef(TypedDict):
    enableAnswerMachineDetection: bool,
    awaitAnswerMachinePrompt: NotRequired[bool],

InstanceIdFilterTypeDef#

# InstanceIdFilterTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import InstanceIdFilterTypeDef


def get_value() -> InstanceIdFilterTypeDef:
    return {
        "value": ...,
    }


# InstanceIdFilterTypeDef definition

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

CampaignSummaryTypeDef#

# CampaignSummaryTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import CampaignSummaryTypeDef


def get_value() -> CampaignSummaryTypeDef:
    return {
        "id": ...,
    }


# CampaignSummaryTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

DeleteCampaignRequestTypeDef#

# DeleteCampaignRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import DeleteCampaignRequestTypeDef


def get_value() -> DeleteCampaignRequestTypeDef:
    return {
        "id": ...,
    }


# DeleteCampaignRequestTypeDef definition

class DeleteCampaignRequestTypeDef(TypedDict):
    id: str,

DeleteConnectInstanceConfigRequestTypeDef#

# DeleteConnectInstanceConfigRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import DeleteConnectInstanceConfigRequestTypeDef


def get_value() -> DeleteConnectInstanceConfigRequestTypeDef:
    return {
        "connectInstanceId": ...,
    }


# DeleteConnectInstanceConfigRequestTypeDef definition

class DeleteConnectInstanceConfigRequestTypeDef(TypedDict):
    connectInstanceId: str,

DeleteInstanceOnboardingJobRequestTypeDef#

# DeleteInstanceOnboardingJobRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import DeleteInstanceOnboardingJobRequestTypeDef


def get_value() -> DeleteInstanceOnboardingJobRequestTypeDef:
    return {
        "connectInstanceId": ...,
    }


# DeleteInstanceOnboardingJobRequestTypeDef definition

class DeleteInstanceOnboardingJobRequestTypeDef(TypedDict):
    connectInstanceId: str,

DescribeCampaignRequestTypeDef#

# DescribeCampaignRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import DescribeCampaignRequestTypeDef


def get_value() -> DescribeCampaignRequestTypeDef:
    return {
        "id": ...,
    }


# DescribeCampaignRequestTypeDef definition

class DescribeCampaignRequestTypeDef(TypedDict):
    id: str,

PredictiveDialerConfigTypeDef#

# PredictiveDialerConfigTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import PredictiveDialerConfigTypeDef


def get_value() -> PredictiveDialerConfigTypeDef:
    return {
        "bandwidthAllocation": ...,
    }


# PredictiveDialerConfigTypeDef definition

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

ProgressiveDialerConfigTypeDef#

# ProgressiveDialerConfigTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import ProgressiveDialerConfigTypeDef


def get_value() -> ProgressiveDialerConfigTypeDef:
    return {
        "bandwidthAllocation": ...,
    }


# ProgressiveDialerConfigTypeDef definition

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

EncryptionConfigTypeDef#

# EncryptionConfigTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import EncryptionConfigTypeDef


def get_value() -> EncryptionConfigTypeDef:
    return {
        "enabled": ...,
    }


# EncryptionConfigTypeDef definition

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

FailedCampaignStateResponseTypeDef#

# FailedCampaignStateResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import FailedCampaignStateResponseTypeDef


def get_value() -> FailedCampaignStateResponseTypeDef:
    return {
        "campaignId": ...,
    }


# FailedCampaignStateResponseTypeDef definition

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

FailedRequestTypeDef#

# FailedRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import FailedRequestTypeDef


def get_value() -> FailedRequestTypeDef:
    return {
        "clientToken": ...,
    }


# FailedRequestTypeDef definition

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

GetCampaignStateBatchRequestTypeDef#

# GetCampaignStateBatchRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import GetCampaignStateBatchRequestTypeDef


def get_value() -> GetCampaignStateBatchRequestTypeDef:
    return {
        "campaignIds": ...,
    }


# GetCampaignStateBatchRequestTypeDef definition

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

SuccessfulCampaignStateResponseTypeDef#

# SuccessfulCampaignStateResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import SuccessfulCampaignStateResponseTypeDef


def get_value() -> SuccessfulCampaignStateResponseTypeDef:
    return {
        "campaignId": ...,
    }


# SuccessfulCampaignStateResponseTypeDef definition

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

GetCampaignStateRequestTypeDef#

# GetCampaignStateRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import GetCampaignStateRequestTypeDef


def get_value() -> GetCampaignStateRequestTypeDef:
    return {
        "id": ...,
    }


# GetCampaignStateRequestTypeDef definition

class GetCampaignStateRequestTypeDef(TypedDict):
    id: str,

GetConnectInstanceConfigRequestTypeDef#

# GetConnectInstanceConfigRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import GetConnectInstanceConfigRequestTypeDef


def get_value() -> GetConnectInstanceConfigRequestTypeDef:
    return {
        "connectInstanceId": ...,
    }


# GetConnectInstanceConfigRequestTypeDef definition

class GetConnectInstanceConfigRequestTypeDef(TypedDict):
    connectInstanceId: str,

GetInstanceOnboardingJobStatusRequestTypeDef#

# GetInstanceOnboardingJobStatusRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import GetInstanceOnboardingJobStatusRequestTypeDef


def get_value() -> GetInstanceOnboardingJobStatusRequestTypeDef:
    return {
        "connectInstanceId": ...,
    }


# GetInstanceOnboardingJobStatusRequestTypeDef definition

class GetInstanceOnboardingJobStatusRequestTypeDef(TypedDict):
    connectInstanceId: str,

InstanceOnboardingJobStatusTypeDef#

# InstanceOnboardingJobStatusTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import InstanceOnboardingJobStatusTypeDef


def get_value() -> InstanceOnboardingJobStatusTypeDef:
    return {
        "connectInstanceId": ...,
    }


# InstanceOnboardingJobStatusTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "arn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    arn: str,

PauseCampaignRequestTypeDef#

# PauseCampaignRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import PauseCampaignRequestTypeDef


def get_value() -> PauseCampaignRequestTypeDef:
    return {
        "id": ...,
    }


# PauseCampaignRequestTypeDef definition

class PauseCampaignRequestTypeDef(TypedDict):
    id: str,

SuccessfulRequestTypeDef#

# SuccessfulRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import SuccessfulRequestTypeDef


def get_value() -> SuccessfulRequestTypeDef:
    return {
        "clientToken": ...,
    }


# SuccessfulRequestTypeDef definition

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

ResumeCampaignRequestTypeDef#

# ResumeCampaignRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import ResumeCampaignRequestTypeDef


def get_value() -> ResumeCampaignRequestTypeDef:
    return {
        "id": ...,
    }


# ResumeCampaignRequestTypeDef definition

class ResumeCampaignRequestTypeDef(TypedDict):
    id: str,

StartCampaignRequestTypeDef#

# StartCampaignRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import StartCampaignRequestTypeDef


def get_value() -> StartCampaignRequestTypeDef:
    return {
        "id": ...,
    }


# StartCampaignRequestTypeDef definition

class StartCampaignRequestTypeDef(TypedDict):
    id: str,

StopCampaignRequestTypeDef#

# StopCampaignRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import StopCampaignRequestTypeDef


def get_value() -> StopCampaignRequestTypeDef:
    return {
        "id": ...,
    }


# StopCampaignRequestTypeDef definition

class StopCampaignRequestTypeDef(TypedDict):
    id: str,

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "arn": ...,
    }


# TagResourceRequestTypeDef definition

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

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "arn": ...,
    }


# UntagResourceRequestTypeDef definition

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

UpdateCampaignNameRequestTypeDef#

# UpdateCampaignNameRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import UpdateCampaignNameRequestTypeDef


def get_value() -> UpdateCampaignNameRequestTypeDef:
    return {
        "id": ...,
    }


# UpdateCampaignNameRequestTypeDef definition

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

OutboundCallConfigTypeDef#

# OutboundCallConfigTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import OutboundCallConfigTypeDef


def get_value() -> OutboundCallConfigTypeDef:
    return {
        "connectContactFlowId": ...,
    }


# OutboundCallConfigTypeDef definition

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

UpdateCampaignOutboundCallConfigRequestTypeDef#

# UpdateCampaignOutboundCallConfigRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import UpdateCampaignOutboundCallConfigRequestTypeDef


def get_value() -> UpdateCampaignOutboundCallConfigRequestTypeDef:
    return {
        "id": ...,
    }


# UpdateCampaignOutboundCallConfigRequestTypeDef definition

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

CampaignFiltersTypeDef#

# CampaignFiltersTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import CampaignFiltersTypeDef


def get_value() -> CampaignFiltersTypeDef:
    return {
        "instanceIdFilter": ...,
    }


# CampaignFiltersTypeDef definition

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

CreateCampaignResponseTypeDef#

# CreateCampaignResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import CreateCampaignResponseTypeDef


def get_value() -> CreateCampaignResponseTypeDef:
    return {
        "id": ...,
    }


# CreateCampaignResponseTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

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

GetCampaignStateResponseTypeDef#

# GetCampaignStateResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import GetCampaignStateResponseTypeDef


def get_value() -> GetCampaignStateResponseTypeDef:
    return {
        "state": ...,
    }


# GetCampaignStateResponseTypeDef definition

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

ListCampaignsResponseTypeDef#

# ListCampaignsResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import ListCampaignsResponseTypeDef


def get_value() -> ListCampaignsResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListCampaignsResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

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

DialRequestTypeDef#

# DialRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import DialRequestTypeDef


def get_value() -> DialRequestTypeDef:
    return {
        "clientToken": ...,
    }


# DialRequestTypeDef definition

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

DialerConfigTypeDef#

# DialerConfigTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import DialerConfigTypeDef


def get_value() -> DialerConfigTypeDef:
    return {
        "progressiveDialerConfig": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import InstanceConfigTypeDef


def get_value() -> InstanceConfigTypeDef:
    return {
        "connectInstanceId": ...,
    }


# InstanceConfigTypeDef definition

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

StartInstanceOnboardingJobRequestTypeDef#

# StartInstanceOnboardingJobRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import StartInstanceOnboardingJobRequestTypeDef


def get_value() -> StartInstanceOnboardingJobRequestTypeDef:
    return {
        "connectInstanceId": ...,
    }


# StartInstanceOnboardingJobRequestTypeDef definition

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

GetCampaignStateBatchResponseTypeDef#

# GetCampaignStateBatchResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import GetCampaignStateBatchResponseTypeDef


def get_value() -> GetCampaignStateBatchResponseTypeDef:
    return {
        "successfulRequests": ...,
    }


# GetCampaignStateBatchResponseTypeDef definition

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

GetInstanceOnboardingJobStatusResponseTypeDef#

# GetInstanceOnboardingJobStatusResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import GetInstanceOnboardingJobStatusResponseTypeDef


def get_value() -> GetInstanceOnboardingJobStatusResponseTypeDef:
    return {
        "connectInstanceOnboardingJobStatus": ...,
    }


# GetInstanceOnboardingJobStatusResponseTypeDef definition

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

StartInstanceOnboardingJobResponseTypeDef#

# StartInstanceOnboardingJobResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import StartInstanceOnboardingJobResponseTypeDef


def get_value() -> StartInstanceOnboardingJobResponseTypeDef:
    return {
        "connectInstanceOnboardingJobStatus": ...,
    }


# StartInstanceOnboardingJobResponseTypeDef definition

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

PutDialRequestBatchResponseTypeDef#

# PutDialRequestBatchResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import PutDialRequestBatchResponseTypeDef


def get_value() -> PutDialRequestBatchResponseTypeDef:
    return {
        "successfulRequests": ...,
    }


# PutDialRequestBatchResponseTypeDef definition

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

ListCampaignsRequestPaginateTypeDef#

# ListCampaignsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import ListCampaignsRequestPaginateTypeDef


def get_value() -> ListCampaignsRequestPaginateTypeDef:
    return {
        "filters": ...,
    }


# ListCampaignsRequestPaginateTypeDef definition

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

ListCampaignsRequestTypeDef#

# ListCampaignsRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import ListCampaignsRequestTypeDef


def get_value() -> ListCampaignsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListCampaignsRequestTypeDef definition

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

PutDialRequestBatchRequestTypeDef#

# PutDialRequestBatchRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import PutDialRequestBatchRequestTypeDef


def get_value() -> PutDialRequestBatchRequestTypeDef:
    return {
        "id": ...,
    }


# PutDialRequestBatchRequestTypeDef definition

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

CampaignTypeDef#

# CampaignTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import CampaignTypeDef


def get_value() -> CampaignTypeDef:
    return {
        "id": ...,
    }


# 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

CreateCampaignRequestTypeDef#

# CreateCampaignRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import CreateCampaignRequestTypeDef


def get_value() -> CreateCampaignRequestTypeDef:
    return {
        "name": ...,
    }


# CreateCampaignRequestTypeDef definition

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

UpdateCampaignDialerConfigRequestTypeDef#

# UpdateCampaignDialerConfigRequestTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import UpdateCampaignDialerConfigRequestTypeDef


def get_value() -> UpdateCampaignDialerConfigRequestTypeDef:
    return {
        "id": ...,
    }


# UpdateCampaignDialerConfigRequestTypeDef definition

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

GetConnectInstanceConfigResponseTypeDef#

# GetConnectInstanceConfigResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import GetConnectInstanceConfigResponseTypeDef


def get_value() -> GetConnectInstanceConfigResponseTypeDef:
    return {
        "connectInstanceConfig": ...,
    }


# GetConnectInstanceConfigResponseTypeDef definition

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

DescribeCampaignResponseTypeDef#

# DescribeCampaignResponseTypeDef TypedDict usage example

from mypy_boto3_connectcampaigns.type_defs import DescribeCampaignResponseTypeDef


def get_value() -> DescribeCampaignResponseTypeDef:
    return {
        "campaign": ...,
    }


# DescribeCampaignResponseTypeDef definition

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