Typed dictionaries
Index > ConnectCampaignService > Typed dictionaries
Auto-generated documentation for ConnectCampaignService type annotations stubs module types-aiobotocore-connectcampaigns.
AnswerMachineDetectionConfigTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import AnswerMachineDetectionConfigTypeDef
def get_value() -> AnswerMachineDetectionConfigTypeDef:
return {
"enableAnswerMachineDetection": ...,
}
InstanceIdFilterTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import InstanceIdFilterTypeDef
def get_value() -> InstanceIdFilterTypeDef:
return {
"operator": ...,
"value": ...,
}
Definition
class InstanceIdFilterTypeDef(TypedDict):
operator: InstanceIdFilterOperatorType, # (1)
value: str,
CampaignSummaryTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import CampaignSummaryTypeDef
def get_value() -> CampaignSummaryTypeDef:
return {
"arn": ...,
"connectInstanceId": ...,
"id": ...,
"name": ...,
}
Definition
class CampaignSummaryTypeDef(TypedDict):
arn: str,
connectInstanceId: str,
id: str,
name: str,
ResponseMetadataTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DeleteCampaignRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import DeleteCampaignRequestRequestTypeDef
def get_value() -> DeleteCampaignRequestRequestTypeDef:
return {
"id": ...,
}
DeleteConnectInstanceConfigRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import DeleteConnectInstanceConfigRequestRequestTypeDef
def get_value() -> DeleteConnectInstanceConfigRequestRequestTypeDef:
return {
"connectInstanceId": ...,
}
Definition
class DeleteConnectInstanceConfigRequestRequestTypeDef(TypedDict):
connectInstanceId: str,
DeleteInstanceOnboardingJobRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import DeleteInstanceOnboardingJobRequestRequestTypeDef
def get_value() -> DeleteInstanceOnboardingJobRequestRequestTypeDef:
return {
"connectInstanceId": ...,
}
Definition
class DeleteInstanceOnboardingJobRequestRequestTypeDef(TypedDict):
connectInstanceId: str,
DescribeCampaignRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import DescribeCampaignRequestRequestTypeDef
def get_value() -> DescribeCampaignRequestRequestTypeDef:
return {
"id": ...,
}
DialRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import DialRequestTypeDef
def get_value() -> DialRequestTypeDef:
return {
"attributes": ...,
"clientToken": ...,
"expirationTime": ...,
"phoneNumber": ...,
}
Definition
class DialRequestTypeDef(TypedDict):
attributes: Mapping[str, str],
clientToken: str,
expirationTime: Union[datetime, str],
phoneNumber: str,
PredictiveDialerConfigTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import PredictiveDialerConfigTypeDef
def get_value() -> PredictiveDialerConfigTypeDef:
return {
"bandwidthAllocation": ...,
}
ProgressiveDialerConfigTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import ProgressiveDialerConfigTypeDef
def get_value() -> ProgressiveDialerConfigTypeDef:
return {
"bandwidthAllocation": ...,
}
EncryptionConfigTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import EncryptionConfigTypeDef
def get_value() -> EncryptionConfigTypeDef:
return {
"enabled": ...,
}
Definition
class EncryptionConfigTypeDef(TypedDict):
enabled: bool,
encryptionType: NotRequired[EncryptionTypeType], # (1)
keyArn: NotRequired[str],
FailedCampaignStateResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import FailedCampaignStateResponseTypeDef
def get_value() -> FailedCampaignStateResponseTypeDef:
return {
"campaignId": ...,
}
Definition
class FailedCampaignStateResponseTypeDef(TypedDict):
campaignId: NotRequired[str],
failureCode: NotRequired[GetCampaignStateBatchFailureCodeType], # (1)
FailedRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import FailedRequestTypeDef
def get_value() -> FailedRequestTypeDef:
return {
"clientToken": ...,
}
Definition
class FailedRequestTypeDef(TypedDict):
clientToken: NotRequired[str],
failureCode: NotRequired[FailureCodeType], # (1)
id: NotRequired[str],
- See FailureCodeType
GetCampaignStateBatchRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import GetCampaignStateBatchRequestRequestTypeDef
def get_value() -> GetCampaignStateBatchRequestRequestTypeDef:
return {
"campaignIds": ...,
}
SuccessfulCampaignStateResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import SuccessfulCampaignStateResponseTypeDef
def get_value() -> SuccessfulCampaignStateResponseTypeDef:
return {
"campaignId": ...,
}
Definition
class SuccessfulCampaignStateResponseTypeDef(TypedDict):
campaignId: NotRequired[str],
state: NotRequired[CampaignStateType], # (1)
GetCampaignStateRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import GetCampaignStateRequestRequestTypeDef
def get_value() -> GetCampaignStateRequestRequestTypeDef:
return {
"id": ...,
}
GetConnectInstanceConfigRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import GetConnectInstanceConfigRequestRequestTypeDef
def get_value() -> GetConnectInstanceConfigRequestRequestTypeDef:
return {
"connectInstanceId": ...,
}
GetInstanceOnboardingJobStatusRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import GetInstanceOnboardingJobStatusRequestRequestTypeDef
def get_value() -> GetInstanceOnboardingJobStatusRequestRequestTypeDef:
return {
"connectInstanceId": ...,
}
Definition
class GetInstanceOnboardingJobStatusRequestRequestTypeDef(TypedDict):
connectInstanceId: str,
InstanceOnboardingJobStatusTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import InstanceOnboardingJobStatusTypeDef
def get_value() -> InstanceOnboardingJobStatusTypeDef:
return {
"connectInstanceId": ...,
"status": ...,
}
Definition
class InstanceOnboardingJobStatusTypeDef(TypedDict):
connectInstanceId: str,
status: InstanceOnboardingJobStatusCodeType, # (2)
failureCode: NotRequired[InstanceOnboardingJobFailureCodeType], # (1)
PaginatorConfigTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"arn": ...,
}
PauseCampaignRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import PauseCampaignRequestRequestTypeDef
def get_value() -> PauseCampaignRequestRequestTypeDef:
return {
"id": ...,
}
SuccessfulRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import SuccessfulRequestTypeDef
def get_value() -> SuccessfulRequestTypeDef:
return {
"clientToken": ...,
}
Definition
class SuccessfulRequestTypeDef(TypedDict):
clientToken: NotRequired[str],
id: NotRequired[str],
ResumeCampaignRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import ResumeCampaignRequestRequestTypeDef
def get_value() -> ResumeCampaignRequestRequestTypeDef:
return {
"id": ...,
}
StartCampaignRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import StartCampaignRequestRequestTypeDef
def get_value() -> StartCampaignRequestRequestTypeDef:
return {
"id": ...,
}
StopCampaignRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import StopCampaignRequestRequestTypeDef
def get_value() -> StopCampaignRequestRequestTypeDef:
return {
"id": ...,
}
TagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"arn": ...,
"tags": ...,
}
UntagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"arn": ...,
"tagKeys": ...,
}
UpdateCampaignNameRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import UpdateCampaignNameRequestRequestTypeDef
def get_value() -> UpdateCampaignNameRequestRequestTypeDef:
return {
"id": ...,
"name": ...,
}
OutboundCallConfigTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import OutboundCallConfigTypeDef
def get_value() -> OutboundCallConfigTypeDef:
return {
"connectContactFlowId": ...,
"connectQueueId": ...,
}
Definition
class OutboundCallConfigTypeDef(TypedDict):
connectContactFlowId: str,
connectQueueId: str,
answerMachineDetectionConfig: NotRequired[AnswerMachineDetectionConfigTypeDef], # (1)
connectSourcePhoneNumber: NotRequired[str],
UpdateCampaignOutboundCallConfigRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import UpdateCampaignOutboundCallConfigRequestRequestTypeDef
def get_value() -> UpdateCampaignOutboundCallConfigRequestRequestTypeDef:
return {
"id": ...,
}
Definition
class UpdateCampaignOutboundCallConfigRequestRequestTypeDef(TypedDict):
id: str,
answerMachineDetectionConfig: NotRequired[AnswerMachineDetectionConfigTypeDef], # (1)
connectContactFlowId: NotRequired[str],
connectSourcePhoneNumber: NotRequired[str],
CampaignFiltersTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import CampaignFiltersTypeDef
def get_value() -> CampaignFiltersTypeDef:
return {
"instanceIdFilter": ...,
}
Definition
class CampaignFiltersTypeDef(TypedDict):
instanceIdFilter: NotRequired[InstanceIdFilterTypeDef], # (1)
CreateCampaignResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import CreateCampaignResponseTypeDef
def get_value() -> CreateCampaignResponseTypeDef:
return {
"arn": ...,
"id": ...,
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class CreateCampaignResponseTypeDef(TypedDict):
arn: str,
id: str,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCampaignStateResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import GetCampaignStateResponseTypeDef
def get_value() -> GetCampaignStateResponseTypeDef:
return {
"state": ...,
"ResponseMetadata": ...,
}
Definition
class GetCampaignStateResponseTypeDef(TypedDict):
state: CampaignStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListCampaignsResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import ListCampaignsResponseTypeDef
def get_value() -> ListCampaignsResponseTypeDef:
return {
"campaignSummaryList": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListCampaignsResponseTypeDef(TypedDict):
campaignSummaryList: List[CampaignSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutDialRequestBatchRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import PutDialRequestBatchRequestRequestTypeDef
def get_value() -> PutDialRequestBatchRequestRequestTypeDef:
return {
"dialRequests": ...,
"id": ...,
}
Definition
class PutDialRequestBatchRequestRequestTypeDef(TypedDict):
dialRequests: Sequence[DialRequestTypeDef], # (1)
id: str,
DialerConfigTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import DialerConfigTypeDef
def get_value() -> DialerConfigTypeDef:
return {
"predictiveDialerConfig": ...,
}
Definition
class DialerConfigTypeDef(TypedDict):
predictiveDialerConfig: NotRequired[PredictiveDialerConfigTypeDef], # (1)
progressiveDialerConfig: NotRequired[ProgressiveDialerConfigTypeDef], # (2)
InstanceConfigTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import InstanceConfigTypeDef
def get_value() -> InstanceConfigTypeDef:
return {
"connectInstanceId": ...,
"encryptionConfig": ...,
"serviceLinkedRoleArn": ...,
}
Definition
class InstanceConfigTypeDef(TypedDict):
connectInstanceId: str,
encryptionConfig: EncryptionConfigTypeDef, # (1)
serviceLinkedRoleArn: str,
StartInstanceOnboardingJobRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import StartInstanceOnboardingJobRequestRequestTypeDef
def get_value() -> StartInstanceOnboardingJobRequestRequestTypeDef:
return {
"connectInstanceId": ...,
"encryptionConfig": ...,
}
Definition
class StartInstanceOnboardingJobRequestRequestTypeDef(TypedDict):
connectInstanceId: str,
encryptionConfig: EncryptionConfigTypeDef, # (1)
GetCampaignStateBatchResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import GetCampaignStateBatchResponseTypeDef
def get_value() -> GetCampaignStateBatchResponseTypeDef:
return {
"failedRequests": ...,
"successfulRequests": ...,
"ResponseMetadata": ...,
}
Definition
class GetCampaignStateBatchResponseTypeDef(TypedDict):
failedRequests: List[FailedCampaignStateResponseTypeDef], # (1)
successfulRequests: List[SuccessfulCampaignStateResponseTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See FailedCampaignStateResponseTypeDef
- See SuccessfulCampaignStateResponseTypeDef
- See ResponseMetadataTypeDef
GetInstanceOnboardingJobStatusResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import GetInstanceOnboardingJobStatusResponseTypeDef
def get_value() -> GetInstanceOnboardingJobStatusResponseTypeDef:
return {
"connectInstanceOnboardingJobStatus": ...,
"ResponseMetadata": ...,
}
Definition
class GetInstanceOnboardingJobStatusResponseTypeDef(TypedDict):
connectInstanceOnboardingJobStatus: InstanceOnboardingJobStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartInstanceOnboardingJobResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import StartInstanceOnboardingJobResponseTypeDef
def get_value() -> StartInstanceOnboardingJobResponseTypeDef:
return {
"connectInstanceOnboardingJobStatus": ...,
"ResponseMetadata": ...,
}
Definition
class StartInstanceOnboardingJobResponseTypeDef(TypedDict):
connectInstanceOnboardingJobStatus: InstanceOnboardingJobStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutDialRequestBatchResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import PutDialRequestBatchResponseTypeDef
def get_value() -> PutDialRequestBatchResponseTypeDef:
return {
"failedRequests": ...,
"successfulRequests": ...,
"ResponseMetadata": ...,
}
Definition
class PutDialRequestBatchResponseTypeDef(TypedDict):
failedRequests: List[FailedRequestTypeDef], # (1)
successfulRequests: List[SuccessfulRequestTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListCampaignsRequestListCampaignsPaginateTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import ListCampaignsRequestListCampaignsPaginateTypeDef
def get_value() -> ListCampaignsRequestListCampaignsPaginateTypeDef:
return {
"filters": ...,
}
Definition
class ListCampaignsRequestListCampaignsPaginateTypeDef(TypedDict):
filters: NotRequired[CampaignFiltersTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListCampaignsRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import ListCampaignsRequestRequestTypeDef
def get_value() -> ListCampaignsRequestRequestTypeDef:
return {
"filters": ...,
}
Definition
class ListCampaignsRequestRequestTypeDef(TypedDict):
filters: NotRequired[CampaignFiltersTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
CampaignTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import CampaignTypeDef
def get_value() -> CampaignTypeDef:
return {
"arn": ...,
"connectInstanceId": ...,
"dialerConfig": ...,
"id": ...,
"name": ...,
"outboundCallConfig": ...,
}
Definition
class CampaignTypeDef(TypedDict):
arn: str,
connectInstanceId: str,
dialerConfig: DialerConfigTypeDef, # (1)
id: str,
name: str,
outboundCallConfig: OutboundCallConfigTypeDef, # (2)
tags: NotRequired[Dict[str, str]],
CreateCampaignRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import CreateCampaignRequestRequestTypeDef
def get_value() -> CreateCampaignRequestRequestTypeDef:
return {
"connectInstanceId": ...,
"dialerConfig": ...,
"name": ...,
"outboundCallConfig": ...,
}
Definition
class CreateCampaignRequestRequestTypeDef(TypedDict):
connectInstanceId: str,
dialerConfig: DialerConfigTypeDef, # (1)
name: str,
outboundCallConfig: OutboundCallConfigTypeDef, # (2)
tags: NotRequired[Mapping[str, str]],
UpdateCampaignDialerConfigRequestRequestTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import UpdateCampaignDialerConfigRequestRequestTypeDef
def get_value() -> UpdateCampaignDialerConfigRequestRequestTypeDef:
return {
"dialerConfig": ...,
"id": ...,
}
Definition
class UpdateCampaignDialerConfigRequestRequestTypeDef(TypedDict):
dialerConfig: DialerConfigTypeDef, # (1)
id: str,
GetConnectInstanceConfigResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import GetConnectInstanceConfigResponseTypeDef
def get_value() -> GetConnectInstanceConfigResponseTypeDef:
return {
"connectInstanceConfig": ...,
"ResponseMetadata": ...,
}
Definition
class GetConnectInstanceConfigResponseTypeDef(TypedDict):
connectInstanceConfig: InstanceConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeCampaignResponseTypeDef
Usage Example
from types_aiobotocore_connectcampaigns.type_defs import DescribeCampaignResponseTypeDef
def get_value() -> DescribeCampaignResponseTypeDef:
return {
"campaign": ...,
"ResponseMetadata": ...,
}