Skip to content

Type definitions#

Index > ConnectCampaignServiceV2 > Type definitions

Auto-generated documentation for ConnectCampaignServiceV2 type annotations stubs module types-boto3-connectcampaignsv2.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

EmailOutboundModeUnionTypeDef#

# EmailOutboundModeUnionTypeDef definition

EmailOutboundModeUnionTypeDef = Union[
    EmailOutboundModeTypeDef,  # (1)
    EmailOutboundModeOutputTypeDef,  # (2)
]
  1. See EmailOutboundModeTypeDef
  2. See EmailOutboundModeOutputTypeDef

LocalTimeZoneConfigUnionTypeDef#

# LocalTimeZoneConfigUnionTypeDef definition

LocalTimeZoneConfigUnionTypeDef = Union[
    LocalTimeZoneConfigTypeDef,  # (1)
    LocalTimeZoneConfigOutputTypeDef,  # (2)
]
  1. See LocalTimeZoneConfigTypeDef
  2. See LocalTimeZoneConfigOutputTypeDef

SmsOutboundModeUnionTypeDef#

# SmsOutboundModeUnionTypeDef definition

SmsOutboundModeUnionTypeDef = Union[
    SmsOutboundModeTypeDef,  # (1)
    SmsOutboundModeOutputTypeDef,  # (2)
]
  1. See SmsOutboundModeTypeDef
  2. See SmsOutboundModeOutputTypeDef

CommunicationLimitsUnionTypeDef#

# CommunicationLimitsUnionTypeDef definition

CommunicationLimitsUnionTypeDef = Union[
    CommunicationLimitsTypeDef,  # (1)
    CommunicationLimitsOutputTypeDef,  # (2)
]
  1. See CommunicationLimitsTypeDef
  2. See CommunicationLimitsOutputTypeDef

OpenHoursUnionTypeDef#

# OpenHoursUnionTypeDef definition

OpenHoursUnionTypeDef = Union[
    OpenHoursTypeDef,  # (1)
    OpenHoursOutputTypeDef,  # (2)
]
  1. See OpenHoursTypeDef
  2. See OpenHoursOutputTypeDef

TelephonyOutboundModeUnionTypeDef#

# TelephonyOutboundModeUnionTypeDef definition

TelephonyOutboundModeUnionTypeDef = Union[
    TelephonyOutboundModeTypeDef,  # (1)
    TelephonyOutboundModeOutputTypeDef,  # (2)
]
  1. See TelephonyOutboundModeTypeDef
  2. See TelephonyOutboundModeOutputTypeDef

RestrictedPeriodsUnionTypeDef#

# RestrictedPeriodsUnionTypeDef definition

RestrictedPeriodsUnionTypeDef = Union[
    RestrictedPeriodsTypeDef,  # (1)
    RestrictedPeriodsOutputTypeDef,  # (2)
]
  1. See RestrictedPeriodsTypeDef
  2. See RestrictedPeriodsOutputTypeDef

EmailChannelSubtypeConfigUnionTypeDef#

# EmailChannelSubtypeConfigUnionTypeDef definition

EmailChannelSubtypeConfigUnionTypeDef = Union[
    EmailChannelSubtypeConfigTypeDef,  # (1)
    EmailChannelSubtypeConfigOutputTypeDef,  # (2)
]
  1. See EmailChannelSubtypeConfigTypeDef
  2. See EmailChannelSubtypeConfigOutputTypeDef

SmsChannelSubtypeConfigUnionTypeDef#

# SmsChannelSubtypeConfigUnionTypeDef definition

SmsChannelSubtypeConfigUnionTypeDef = Union[
    SmsChannelSubtypeConfigTypeDef,  # (1)
    SmsChannelSubtypeConfigOutputTypeDef,  # (2)
]
  1. See SmsChannelSubtypeConfigTypeDef
  2. See SmsChannelSubtypeConfigOutputTypeDef

TelephonyChannelSubtypeConfigUnionTypeDef#

# TelephonyChannelSubtypeConfigUnionTypeDef definition

TelephonyChannelSubtypeConfigUnionTypeDef = Union[
    TelephonyChannelSubtypeConfigTypeDef,  # (1)
    TelephonyChannelSubtypeConfigOutputTypeDef,  # (2)
]
  1. See TelephonyChannelSubtypeConfigTypeDef
  2. See TelephonyChannelSubtypeConfigOutputTypeDef

TimeWindowUnionTypeDef#

# TimeWindowUnionTypeDef definition

TimeWindowUnionTypeDef = Union[
    TimeWindowTypeDef,  # (1)
    TimeWindowOutputTypeDef,  # (2)
]
  1. See TimeWindowTypeDef
  2. See TimeWindowOutputTypeDef

AnswerMachineDetectionConfigTypeDef#

# AnswerMachineDetectionConfigTypeDef definition

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

InstanceIdFilterTypeDef#

# InstanceIdFilterTypeDef definition

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

ScheduleOutputTypeDef#

# ScheduleOutputTypeDef definition

class ScheduleOutputTypeDef(TypedDict):
    startTime: datetime,
    endTime: datetime,
    refreshFrequency: NotRequired[str],

EmailChannelSubtypeParametersTypeDef#

# EmailChannelSubtypeParametersTypeDef definition

class EmailChannelSubtypeParametersTypeDef(TypedDict):
    destinationEmailAddress: str,
    templateParameters: Mapping[str, str],
    connectSourceEmailAddress: NotRequired[str],
    templateArn: NotRequired[str],

SmsChannelSubtypeParametersTypeDef#

# SmsChannelSubtypeParametersTypeDef definition

class SmsChannelSubtypeParametersTypeDef(TypedDict):
    destinationPhoneNumber: str,
    templateParameters: Mapping[str, str],
    connectSourcePhoneNumberArn: NotRequired[str],
    templateArn: NotRequired[str],

CommunicationLimitTypeDef#

# CommunicationLimitTypeDef definition

class CommunicationLimitTypeDef(TypedDict):
    maxCountPerRecipient: int,
    frequency: int,
    unit: CommunicationLimitTimeUnitType,  # (1)
  1. See CommunicationLimitTimeUnitType

LocalTimeZoneConfigOutputTypeDef#

# LocalTimeZoneConfigOutputTypeDef definition

class LocalTimeZoneConfigOutputTypeDef(TypedDict):
    defaultTimeZone: NotRequired[str],
    localTimeZoneDetection: NotRequired[list[LocalTimeZoneDetectionTypeType]],  # (1)
  1. See LocalTimeZoneDetectionTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CustomerProfilesIntegrationConfigTypeDef#

# CustomerProfilesIntegrationConfigTypeDef definition

class CustomerProfilesIntegrationConfigTypeDef(TypedDict):
    domainArn: str,
    objectTypeNames: Mapping[EventTypeType, str],  # (1)
  1. See EventTypeType

CustomerProfilesIntegrationIdentifierTypeDef#

# CustomerProfilesIntegrationIdentifierTypeDef definition

class CustomerProfilesIntegrationIdentifierTypeDef(TypedDict):
    domainArn: str,

CustomerProfilesIntegrationSummaryTypeDef#

# CustomerProfilesIntegrationSummaryTypeDef definition

class CustomerProfilesIntegrationSummaryTypeDef(TypedDict):
    domainArn: str,
    objectTypeNames: dict[EventTypeType, str],  # (1)
  1. See EventTypeType

DeleteCampaignChannelSubtypeConfigRequestRequestTypeDef#

# DeleteCampaignChannelSubtypeConfigRequestRequestTypeDef definition

class DeleteCampaignChannelSubtypeConfigRequestRequestTypeDef(TypedDict):
    id: str,
    channelSubtype: ChannelSubtypeType,  # (1)
  1. See ChannelSubtypeType

DeleteCampaignCommunicationLimitsRequestRequestTypeDef#

# DeleteCampaignCommunicationLimitsRequestRequestTypeDef definition

class DeleteCampaignCommunicationLimitsRequestRequestTypeDef(TypedDict):
    id: str,
    config: CommunicationLimitsConfigTypeType,  # (1)
  1. See CommunicationLimitsConfigTypeType

DeleteCampaignCommunicationTimeRequestRequestTypeDef#

# DeleteCampaignCommunicationTimeRequestRequestTypeDef definition

class DeleteCampaignCommunicationTimeRequestRequestTypeDef(TypedDict):
    id: str,
    config: CommunicationTimeConfigTypeType,  # (1)
  1. See CommunicationTimeConfigTypeType

DeleteCampaignRequestRequestTypeDef#

# DeleteCampaignRequestRequestTypeDef definition

class DeleteCampaignRequestRequestTypeDef(TypedDict):
    id: str,

DeleteConnectInstanceConfigRequestRequestTypeDef#

# DeleteConnectInstanceConfigRequestRequestTypeDef definition

class DeleteConnectInstanceConfigRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,
    campaignDeletionPolicy: NotRequired[CampaignDeletionPolicyType],  # (1)
  1. See CampaignDeletionPolicyType

DeleteInstanceOnboardingJobRequestRequestTypeDef#

# DeleteInstanceOnboardingJobRequestRequestTypeDef definition

class DeleteInstanceOnboardingJobRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,

DescribeCampaignRequestRequestTypeDef#

# DescribeCampaignRequestRequestTypeDef definition

class DescribeCampaignRequestRequestTypeDef(TypedDict):
    id: str,

EmailOutboundConfigTypeDef#

# EmailOutboundConfigTypeDef definition

class EmailOutboundConfigTypeDef(TypedDict):
    connectSourceEmailAddress: str,
    wisdomTemplateArn: str,
    sourceEmailAddressDisplayName: NotRequired[str],

EmailOutboundModeOutputTypeDef#

# EmailOutboundModeOutputTypeDef definition

class EmailOutboundModeOutputTypeDef(TypedDict):
    agentless: NotRequired[dict[str, Any]],

EmailOutboundModeTypeDef#

# EmailOutboundModeTypeDef definition

class EmailOutboundModeTypeDef(TypedDict):
    agentless: NotRequired[Mapping[str, Any]],

EncryptionConfigTypeDef#

# EncryptionConfigTypeDef definition

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

EventTriggerTypeDef#

# EventTriggerTypeDef definition

class EventTriggerTypeDef(TypedDict):
    customerProfilesDomainArn: NotRequired[str],

FailedCampaignStateResponseTypeDef#

# FailedCampaignStateResponseTypeDef definition

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

FailedProfileOutboundRequestTypeDef#

# FailedProfileOutboundRequestTypeDef definition

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

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

QConnectIntegrationConfigTypeDef#

# QConnectIntegrationConfigTypeDef definition

class QConnectIntegrationConfigTypeDef(TypedDict):
    knowledgeBaseArn: str,

QConnectIntegrationIdentifierTypeDef#

# QConnectIntegrationIdentifierTypeDef definition

class QConnectIntegrationIdentifierTypeDef(TypedDict):
    knowledgeBaseArn: str,

QConnectIntegrationSummaryTypeDef#

# QConnectIntegrationSummaryTypeDef definition

class QConnectIntegrationSummaryTypeDef(TypedDict):
    knowledgeBaseArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListConnectInstanceIntegrationsRequestRequestTypeDef#

# ListConnectInstanceIntegrationsRequestRequestTypeDef definition

class ListConnectInstanceIntegrationsRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    arn: str,

LocalTimeZoneConfigTypeDef#

# LocalTimeZoneConfigTypeDef definition

class LocalTimeZoneConfigTypeDef(TypedDict):
    defaultTimeZone: NotRequired[str],
    localTimeZoneDetection: NotRequired[Sequence[LocalTimeZoneDetectionTypeType]],  # (1)
  1. See LocalTimeZoneDetectionTypeType

TimeRangeTypeDef#

# TimeRangeTypeDef definition

class TimeRangeTypeDef(TypedDict):
    startTime: str,
    endTime: str,

PauseCampaignRequestRequestTypeDef#

# PauseCampaignRequestRequestTypeDef definition

class PauseCampaignRequestRequestTypeDef(TypedDict):
    id: str,

PredictiveConfigTypeDef#

# PredictiveConfigTypeDef definition

class PredictiveConfigTypeDef(TypedDict):
    bandwidthAllocation: float,

ProgressiveConfigTypeDef#

# ProgressiveConfigTypeDef definition

class ProgressiveConfigTypeDef(TypedDict):
    bandwidthAllocation: float,

SuccessfulRequestTypeDef#

# SuccessfulRequestTypeDef definition

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

SuccessfulProfileOutboundRequestTypeDef#

# SuccessfulProfileOutboundRequestTypeDef definition

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

RestrictedPeriodTypeDef#

# RestrictedPeriodTypeDef definition

class RestrictedPeriodTypeDef(TypedDict):
    startDate: str,
    endDate: str,
    name: NotRequired[str],

ResumeCampaignRequestRequestTypeDef#

# ResumeCampaignRequestRequestTypeDef definition

class ResumeCampaignRequestRequestTypeDef(TypedDict):
    id: str,

SmsOutboundConfigTypeDef#

# SmsOutboundConfigTypeDef definition

class SmsOutboundConfigTypeDef(TypedDict):
    connectSourcePhoneNumberArn: str,
    wisdomTemplateArn: str,

SmsOutboundModeOutputTypeDef#

# SmsOutboundModeOutputTypeDef definition

class SmsOutboundModeOutputTypeDef(TypedDict):
    agentless: NotRequired[dict[str, Any]],

SmsOutboundModeTypeDef#

# SmsOutboundModeTypeDef definition

class SmsOutboundModeTypeDef(TypedDict):
    agentless: NotRequired[Mapping[str, Any]],

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

UpdateCampaignFlowAssociationRequestRequestTypeDef#

# UpdateCampaignFlowAssociationRequestRequestTypeDef definition

class UpdateCampaignFlowAssociationRequestRequestTypeDef(TypedDict):
    id: str,
    connectCampaignFlowArn: str,

UpdateCampaignNameRequestRequestTypeDef#

# UpdateCampaignNameRequestRequestTypeDef definition

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

TelephonyChannelSubtypeParametersTypeDef#

# TelephonyChannelSubtypeParametersTypeDef definition

class TelephonyChannelSubtypeParametersTypeDef(TypedDict):
    destinationPhoneNumber: str,
    attributes: Mapping[str, str],
    connectSourcePhoneNumber: NotRequired[str],
    answerMachineDetectionConfig: NotRequired[AnswerMachineDetectionConfigTypeDef],  # (1)
  1. See AnswerMachineDetectionConfigTypeDef

TelephonyOutboundConfigTypeDef#

# TelephonyOutboundConfigTypeDef definition

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

CampaignFiltersTypeDef#

# CampaignFiltersTypeDef definition

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

CampaignSummaryTypeDef#

# CampaignSummaryTypeDef definition

class CampaignSummaryTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    connectInstanceId: str,
    channelSubtypes: list[ChannelSubtypeType],  # (1)
    schedule: NotRequired[ScheduleOutputTypeDef],  # (2)
    connectCampaignFlowArn: NotRequired[str],
  1. See ChannelSubtypeType
  2. See ScheduleOutputTypeDef

CommunicationLimitsOutputTypeDef#

# CommunicationLimitsOutputTypeDef definition

class CommunicationLimitsOutputTypeDef(TypedDict):
    communicationLimitsList: NotRequired[list[CommunicationLimitTypeDef]],  # (1)
  1. See CommunicationLimitTypeDef

CommunicationLimitsTypeDef#

# CommunicationLimitsTypeDef definition

class CommunicationLimitsTypeDef(TypedDict):
    communicationLimitsList: NotRequired[Sequence[CommunicationLimitTypeDef]],  # (1)
  1. See CommunicationLimitTypeDef

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

EmailChannelSubtypeConfigOutputTypeDef#

# EmailChannelSubtypeConfigOutputTypeDef definition

class EmailChannelSubtypeConfigOutputTypeDef(TypedDict):
    outboundMode: EmailOutboundModeOutputTypeDef,  # (1)
    defaultOutboundConfig: EmailOutboundConfigTypeDef,  # (2)
    capacity: NotRequired[float],
  1. See EmailOutboundModeOutputTypeDef
  2. See EmailOutboundConfigTypeDef

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

SourceTypeDef#

# SourceTypeDef definition

class SourceTypeDef(TypedDict):
    customerProfilesSegmentArn: NotRequired[str],
    eventTrigger: NotRequired[EventTriggerTypeDef],  # (1)
  1. See EventTriggerTypeDef

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

IntegrationConfigTypeDef#

# IntegrationConfigTypeDef definition

class IntegrationConfigTypeDef(TypedDict):
    customerProfiles: NotRequired[CustomerProfilesIntegrationConfigTypeDef],  # (1)
    qConnect: NotRequired[QConnectIntegrationConfigTypeDef],  # (2)
  1. See CustomerProfilesIntegrationConfigTypeDef
  2. See QConnectIntegrationConfigTypeDef

IntegrationIdentifierTypeDef#

# IntegrationIdentifierTypeDef definition

class IntegrationIdentifierTypeDef(TypedDict):
    customerProfiles: NotRequired[CustomerProfilesIntegrationIdentifierTypeDef],  # (1)
    qConnect: NotRequired[QConnectIntegrationIdentifierTypeDef],  # (2)
  1. See CustomerProfilesIntegrationIdentifierTypeDef
  2. See QConnectIntegrationIdentifierTypeDef

IntegrationSummaryTypeDef#

# IntegrationSummaryTypeDef definition

class IntegrationSummaryTypeDef(TypedDict):
    customerProfiles: NotRequired[CustomerProfilesIntegrationSummaryTypeDef],  # (1)
    qConnect: NotRequired[QConnectIntegrationSummaryTypeDef],  # (2)
  1. See CustomerProfilesIntegrationSummaryTypeDef
  2. See QConnectIntegrationSummaryTypeDef

ListConnectInstanceIntegrationsRequestPaginateTypeDef#

# ListConnectInstanceIntegrationsRequestPaginateTypeDef definition

class ListConnectInstanceIntegrationsRequestPaginateTypeDef(TypedDict):
    connectInstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

OpenHoursOutputTypeDef#

# OpenHoursOutputTypeDef definition

class OpenHoursOutputTypeDef(TypedDict):
    dailyHours: NotRequired[dict[DayOfWeekType, list[TimeRangeTypeDef]]],  # (1)
  1. See DayOfWeekType TimeRangeTypeDef

OpenHoursTypeDef#

# OpenHoursTypeDef definition

class OpenHoursTypeDef(TypedDict):
    dailyHours: NotRequired[Mapping[DayOfWeekType, Sequence[TimeRangeTypeDef]]],  # (1)
  1. See DayOfWeekType TimeRangeTypeDef

ProfileOutboundRequestTypeDef#

# ProfileOutboundRequestTypeDef definition

class ProfileOutboundRequestTypeDef(TypedDict):
    clientToken: str,
    profileId: str,
    expirationTime: NotRequired[TimestampTypeDef],

ScheduleTypeDef#

# ScheduleTypeDef definition

class ScheduleTypeDef(TypedDict):
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    refreshFrequency: NotRequired[str],

TelephonyOutboundModeOutputTypeDef#

# TelephonyOutboundModeOutputTypeDef definition

class TelephonyOutboundModeOutputTypeDef(TypedDict):
    progressive: NotRequired[ProgressiveConfigTypeDef],  # (1)
    predictive: NotRequired[PredictiveConfigTypeDef],  # (2)
    agentless: NotRequired[dict[str, Any]],
  1. See ProgressiveConfigTypeDef
  2. See PredictiveConfigTypeDef

TelephonyOutboundModeTypeDef#

# TelephonyOutboundModeTypeDef definition

class TelephonyOutboundModeTypeDef(TypedDict):
    progressive: NotRequired[ProgressiveConfigTypeDef],  # (1)
    predictive: NotRequired[PredictiveConfigTypeDef],  # (2)
    agentless: NotRequired[Mapping[str, Any]],
  1. See ProgressiveConfigTypeDef
  2. See PredictiveConfigTypeDef

PutOutboundRequestBatchResponseTypeDef#

# PutOutboundRequestBatchResponseTypeDef definition

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

PutProfileOutboundRequestBatchResponseTypeDef#

# PutProfileOutboundRequestBatchResponseTypeDef definition

class PutProfileOutboundRequestBatchResponseTypeDef(TypedDict):
    successfulRequests: list[SuccessfulProfileOutboundRequestTypeDef],  # (1)
    failedRequests: list[FailedProfileOutboundRequestTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SuccessfulProfileOutboundRequestTypeDef
  2. See FailedProfileOutboundRequestTypeDef
  3. See ResponseMetadataTypeDef

RestrictedPeriodsOutputTypeDef#

# RestrictedPeriodsOutputTypeDef definition

class RestrictedPeriodsOutputTypeDef(TypedDict):
    restrictedPeriodList: NotRequired[list[RestrictedPeriodTypeDef]],  # (1)
  1. See RestrictedPeriodTypeDef

RestrictedPeriodsTypeDef#

# RestrictedPeriodsTypeDef definition

class RestrictedPeriodsTypeDef(TypedDict):
    restrictedPeriodList: NotRequired[Sequence[RestrictedPeriodTypeDef]],  # (1)
  1. See RestrictedPeriodTypeDef

SmsChannelSubtypeConfigOutputTypeDef#

# SmsChannelSubtypeConfigOutputTypeDef definition

class SmsChannelSubtypeConfigOutputTypeDef(TypedDict):
    outboundMode: SmsOutboundModeOutputTypeDef,  # (1)
    defaultOutboundConfig: SmsOutboundConfigTypeDef,  # (2)
    capacity: NotRequired[float],
  1. See SmsOutboundModeOutputTypeDef
  2. See SmsOutboundConfigTypeDef

ChannelSubtypeParametersTypeDef#

# ChannelSubtypeParametersTypeDef definition

class ChannelSubtypeParametersTypeDef(TypedDict):
    telephony: NotRequired[TelephonyChannelSubtypeParametersTypeDef],  # (1)
    sms: NotRequired[SmsChannelSubtypeParametersTypeDef],  # (2)
    email: NotRequired[EmailChannelSubtypeParametersTypeDef],  # (3)
  1. See TelephonyChannelSubtypeParametersTypeDef
  2. See SmsChannelSubtypeParametersTypeDef
  3. See EmailChannelSubtypeParametersTypeDef

ListCampaignsRequestPaginateTypeDef#

# ListCampaignsRequestPaginateTypeDef definition

class ListCampaignsRequestPaginateTypeDef(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

ListCampaignsResponseTypeDef#

# ListCampaignsResponseTypeDef definition

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

CommunicationLimitsConfigOutputTypeDef#

# CommunicationLimitsConfigOutputTypeDef definition

class CommunicationLimitsConfigOutputTypeDef(TypedDict):
    allChannelSubtypes: NotRequired[CommunicationLimitsOutputTypeDef],  # (1)
  1. See CommunicationLimitsOutputTypeDef

EmailChannelSubtypeConfigTypeDef#

# EmailChannelSubtypeConfigTypeDef definition

class EmailChannelSubtypeConfigTypeDef(TypedDict):
    outboundMode: EmailOutboundModeUnionTypeDef,  # (1)
    defaultOutboundConfig: EmailOutboundConfigTypeDef,  # (2)
    capacity: NotRequired[float],
  1. See EmailOutboundModeTypeDef EmailOutboundModeOutputTypeDef
  2. See EmailOutboundConfigTypeDef

GetConnectInstanceConfigResponseTypeDef#

# GetConnectInstanceConfigResponseTypeDef definition

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

UpdateCampaignSourceRequestRequestTypeDef#

# UpdateCampaignSourceRequestRequestTypeDef definition

class UpdateCampaignSourceRequestRequestTypeDef(TypedDict):
    id: str,
    source: SourceTypeDef,  # (1)
  1. See SourceTypeDef

PutConnectInstanceIntegrationRequestRequestTypeDef#

# PutConnectInstanceIntegrationRequestRequestTypeDef definition

class PutConnectInstanceIntegrationRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,
    integrationConfig: IntegrationConfigTypeDef,  # (1)
  1. See IntegrationConfigTypeDef

DeleteConnectInstanceIntegrationRequestRequestTypeDef#

# DeleteConnectInstanceIntegrationRequestRequestTypeDef definition

class DeleteConnectInstanceIntegrationRequestRequestTypeDef(TypedDict):
    connectInstanceId: str,
    integrationIdentifier: IntegrationIdentifierTypeDef,  # (1)
  1. See IntegrationIdentifierTypeDef

ListConnectInstanceIntegrationsResponseTypeDef#

# ListConnectInstanceIntegrationsResponseTypeDef definition

class ListConnectInstanceIntegrationsResponseTypeDef(TypedDict):
    integrationSummaryList: list[IntegrationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See IntegrationSummaryTypeDef
  2. See ResponseMetadataTypeDef

PutProfileOutboundRequestBatchRequestRequestTypeDef#

# PutProfileOutboundRequestBatchRequestRequestTypeDef definition

class PutProfileOutboundRequestBatchRequestRequestTypeDef(TypedDict):
    id: str,
    profileOutboundRequests: Sequence[ProfileOutboundRequestTypeDef],  # (1)
  1. See ProfileOutboundRequestTypeDef

UpdateCampaignScheduleRequestRequestTypeDef#

# UpdateCampaignScheduleRequestRequestTypeDef definition

class UpdateCampaignScheduleRequestRequestTypeDef(TypedDict):
    id: str,
    schedule: ScheduleTypeDef,  # (1)
  1. See ScheduleTypeDef

TelephonyChannelSubtypeConfigOutputTypeDef#

# TelephonyChannelSubtypeConfigOutputTypeDef definition

class TelephonyChannelSubtypeConfigOutputTypeDef(TypedDict):
    outboundMode: TelephonyOutboundModeOutputTypeDef,  # (1)
    defaultOutboundConfig: TelephonyOutboundConfigTypeDef,  # (2)
    capacity: NotRequired[float],
    connectQueueId: NotRequired[str],
  1. See TelephonyOutboundModeOutputTypeDef
  2. See TelephonyOutboundConfigTypeDef

TimeWindowOutputTypeDef#

# TimeWindowOutputTypeDef definition

class TimeWindowOutputTypeDef(TypedDict):
    openHours: OpenHoursOutputTypeDef,  # (1)
    restrictedPeriods: NotRequired[RestrictedPeriodsOutputTypeDef],  # (2)
  1. See OpenHoursOutputTypeDef
  2. See RestrictedPeriodsOutputTypeDef

SmsChannelSubtypeConfigTypeDef#

# SmsChannelSubtypeConfigTypeDef definition

class SmsChannelSubtypeConfigTypeDef(TypedDict):
    outboundMode: SmsOutboundModeUnionTypeDef,  # (1)
    defaultOutboundConfig: SmsOutboundConfigTypeDef,  # (2)
    capacity: NotRequired[float],
  1. See SmsOutboundModeTypeDef SmsOutboundModeOutputTypeDef
  2. See SmsOutboundConfigTypeDef

OutboundRequestTypeDef#

# OutboundRequestTypeDef definition

class OutboundRequestTypeDef(TypedDict):
    clientToken: str,
    expirationTime: TimestampTypeDef,
    channelSubtypeParameters: ChannelSubtypeParametersTypeDef,  # (1)
  1. See ChannelSubtypeParametersTypeDef

CommunicationLimitsConfigTypeDef#

# CommunicationLimitsConfigTypeDef definition

class CommunicationLimitsConfigTypeDef(TypedDict):
    allChannelSubtypes: NotRequired[CommunicationLimitsUnionTypeDef],  # (1)
  1. See CommunicationLimitsTypeDef CommunicationLimitsOutputTypeDef

ChannelSubtypeConfigOutputTypeDef#

# ChannelSubtypeConfigOutputTypeDef definition

class ChannelSubtypeConfigOutputTypeDef(TypedDict):
    telephony: NotRequired[TelephonyChannelSubtypeConfigOutputTypeDef],  # (1)
    sms: NotRequired[SmsChannelSubtypeConfigOutputTypeDef],  # (2)
    email: NotRequired[EmailChannelSubtypeConfigOutputTypeDef],  # (3)
  1. See TelephonyChannelSubtypeConfigOutputTypeDef
  2. See SmsChannelSubtypeConfigOutputTypeDef
  3. See EmailChannelSubtypeConfigOutputTypeDef

TelephonyChannelSubtypeConfigTypeDef#

# TelephonyChannelSubtypeConfigTypeDef definition

class TelephonyChannelSubtypeConfigTypeDef(TypedDict):
    outboundMode: TelephonyOutboundModeUnionTypeDef,  # (1)
    defaultOutboundConfig: TelephonyOutboundConfigTypeDef,  # (2)
    capacity: NotRequired[float],
    connectQueueId: NotRequired[str],
  1. See TelephonyOutboundModeTypeDef TelephonyOutboundModeOutputTypeDef
  2. See TelephonyOutboundConfigTypeDef

CommunicationTimeConfigOutputTypeDef#

# CommunicationTimeConfigOutputTypeDef definition

class CommunicationTimeConfigOutputTypeDef(TypedDict):
    localTimeZoneConfig: LocalTimeZoneConfigOutputTypeDef,  # (1)
    telephony: NotRequired[TimeWindowOutputTypeDef],  # (2)
    sms: NotRequired[TimeWindowOutputTypeDef],  # (2)
    email: NotRequired[TimeWindowOutputTypeDef],  # (2)
  1. See LocalTimeZoneConfigOutputTypeDef
  2. See TimeWindowOutputTypeDef
  3. See TimeWindowOutputTypeDef
  4. See TimeWindowOutputTypeDef

TimeWindowTypeDef#

# TimeWindowTypeDef definition

class TimeWindowTypeDef(TypedDict):
    openHours: OpenHoursUnionTypeDef,  # (1)
    restrictedPeriods: NotRequired[RestrictedPeriodsUnionTypeDef],  # (2)
  1. See OpenHoursTypeDef OpenHoursOutputTypeDef
  2. See RestrictedPeriodsTypeDef RestrictedPeriodsOutputTypeDef

PutOutboundRequestBatchRequestRequestTypeDef#

# PutOutboundRequestBatchRequestRequestTypeDef definition

class PutOutboundRequestBatchRequestRequestTypeDef(TypedDict):
    id: str,
    outboundRequests: Sequence[OutboundRequestTypeDef],  # (1)
  1. See OutboundRequestTypeDef

UpdateCampaignCommunicationLimitsRequestRequestTypeDef#

# UpdateCampaignCommunicationLimitsRequestRequestTypeDef definition

class UpdateCampaignCommunicationLimitsRequestRequestTypeDef(TypedDict):
    id: str,
    communicationLimitsOverride: CommunicationLimitsConfigTypeDef,  # (1)
  1. See CommunicationLimitsConfigTypeDef

CampaignTypeDef#

# CampaignTypeDef definition

class CampaignTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    connectInstanceId: str,
    channelSubtypeConfig: ChannelSubtypeConfigOutputTypeDef,  # (1)
    source: NotRequired[SourceTypeDef],  # (2)
    connectCampaignFlowArn: NotRequired[str],
    schedule: NotRequired[ScheduleOutputTypeDef],  # (3)
    communicationTimeConfig: NotRequired[CommunicationTimeConfigOutputTypeDef],  # (4)
    communicationLimitsOverride: NotRequired[CommunicationLimitsConfigOutputTypeDef],  # (5)
    tags: NotRequired[dict[str, str]],
  1. See ChannelSubtypeConfigOutputTypeDef
  2. See SourceTypeDef
  3. See ScheduleOutputTypeDef
  4. See CommunicationTimeConfigOutputTypeDef
  5. See CommunicationLimitsConfigOutputTypeDef

ChannelSubtypeConfigTypeDef#

# ChannelSubtypeConfigTypeDef definition

class ChannelSubtypeConfigTypeDef(TypedDict):
    telephony: NotRequired[TelephonyChannelSubtypeConfigUnionTypeDef],  # (1)
    sms: NotRequired[SmsChannelSubtypeConfigUnionTypeDef],  # (2)
    email: NotRequired[EmailChannelSubtypeConfigUnionTypeDef],  # (3)
  1. See TelephonyChannelSubtypeConfigTypeDef TelephonyChannelSubtypeConfigOutputTypeDef
  2. See SmsChannelSubtypeConfigTypeDef SmsChannelSubtypeConfigOutputTypeDef
  3. See EmailChannelSubtypeConfigTypeDef EmailChannelSubtypeConfigOutputTypeDef

DescribeCampaignResponseTypeDef#

# DescribeCampaignResponseTypeDef definition

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

CommunicationTimeConfigTypeDef#

# CommunicationTimeConfigTypeDef definition

class CommunicationTimeConfigTypeDef(TypedDict):
    localTimeZoneConfig: LocalTimeZoneConfigUnionTypeDef,  # (1)
    telephony: NotRequired[TimeWindowUnionTypeDef],  # (2)
    sms: NotRequired[TimeWindowUnionTypeDef],  # (2)
    email: NotRequired[TimeWindowUnionTypeDef],  # (2)
  1. See LocalTimeZoneConfigTypeDef LocalTimeZoneConfigOutputTypeDef
  2. See TimeWindowTypeDef TimeWindowOutputTypeDef
  3. See TimeWindowTypeDef TimeWindowOutputTypeDef
  4. See TimeWindowTypeDef TimeWindowOutputTypeDef

UpdateCampaignChannelSubtypeConfigRequestRequestTypeDef#

# UpdateCampaignChannelSubtypeConfigRequestRequestTypeDef definition

class UpdateCampaignChannelSubtypeConfigRequestRequestTypeDef(TypedDict):
    id: str,
    channelSubtypeConfig: ChannelSubtypeConfigTypeDef,  # (1)
  1. See ChannelSubtypeConfigTypeDef

CreateCampaignRequestRequestTypeDef#

# CreateCampaignRequestRequestTypeDef definition

class CreateCampaignRequestRequestTypeDef(TypedDict):
    name: str,
    connectInstanceId: str,
    channelSubtypeConfig: ChannelSubtypeConfigTypeDef,  # (1)
    source: NotRequired[SourceTypeDef],  # (2)
    connectCampaignFlowArn: NotRequired[str],
    schedule: NotRequired[ScheduleTypeDef],  # (3)
    communicationTimeConfig: NotRequired[CommunicationTimeConfigTypeDef],  # (4)
    communicationLimitsOverride: NotRequired[CommunicationLimitsConfigTypeDef],  # (5)
    tags: NotRequired[Mapping[str, str]],
  1. See ChannelSubtypeConfigTypeDef
  2. See SourceTypeDef
  3. See ScheduleTypeDef
  4. See CommunicationTimeConfigTypeDef
  5. See CommunicationLimitsConfigTypeDef

UpdateCampaignCommunicationTimeRequestRequestTypeDef#

# UpdateCampaignCommunicationTimeRequestRequestTypeDef definition

class UpdateCampaignCommunicationTimeRequestRequestTypeDef(TypedDict):
    id: str,
    communicationTimeConfig: CommunicationTimeConfigTypeDef,  # (1)
  1. See CommunicationTimeConfigTypeDef