Module Awso_connectcampaignsv2.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule Iso8601Time : sig ... end

Time in ISO 8601 format, e.g. T23:11

Sourcemodule AgentAction : sig ... end
Sourcemodule TimeoutDuration : sig ... end

Timeout duration for a preview contact in seconds.

Sourcemodule TimeRange : sig ... end

Time range in 24 hour format

Sourcemodule Iso8601Date : sig ... end

Date in ISO 8601 format, e.g. 2024-01-01

Sourcemodule RestrictedPeriodName : sig ... end

The name of a restricted period.

Sourcemodule AttributeName : sig ... end

The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.

Sourcemodule AttributeValue : sig ... end

The value of the attribute.

Sourcemodule Boolean : sig ... end
Sourcemodule BandwidthAllocation : sig ... end

The bandwidth allocation of a queue resource.

Sourcemodule AgentActions : sig ... end
Sourcemodule TimeoutConfig : sig ... end

Timeout Config for preview contacts.

Sourcemodule DayOfWeek : sig ... end
Sourcemodule TimeRangeList : sig ... end
Sourcemodule RestrictedPeriod : sig ... end

Restricted period

Sourcemodule Arn : sig ... end

Amazon Resource Names(ARN)

Sourcemodule Attributes : sig ... end
Sourcemodule EmailAddress : sig ... end

Source/Destination Email address used for Email messages

Sourcemodule DestinationPhoneNumber : sig ... end

The phone number of the customer, in E.164 format.

Answering Machine Detection config

Sourcemodule RingTimeout : sig ... end

Ring timeout for outbound calls

Sourcemodule SourcePhoneNumber : sig ... end

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

Sourcemodule EventType : sig ... end
Sourcemodule ObjectTypeName : sig ... end

Object type name

Sourcemodule EmailDisplayName : sig ... end

Display name for Email Address

Sourcemodule AgentlessConfig : sig ... end

Agentless config

Sourcemodule ContactFlowId : sig ... end

The identifier of the contact flow for the outbound call.

Sourcemodule PredictiveConfig : sig ... end

Predictive config

Sourcemodule PreviewConfig : sig ... end

Preview config

Sourcemodule ProgressiveConfig : sig ... end

Progressive config

Sourcemodule CommunicationLimit : sig ... end

Communication Limit

Sourcemodule DailyHours : sig ... end
Sourcemodule RestrictedPeriodList : sig ... end

Parameters for the Email Channel Subtype

Parameters for the SMS Channel Subtype

Parameters for the Telephony Channel Subtype

Parameters for the WhatsApp Channel Subtype

Sourcemodule ObjectTypeNamesMap : sig ... end
Sourcemodule LambdaArn : sig ... end

Lambda ARN for integration with Connect instances

Sourcemodule ChannelSubtype : sig ... end
Sourcemodule Iso8601Duration : sig ... end

Time duration in ISO 8601 format

Sourcemodule TimeStamp : sig ... end

Timestamp with no UTC offset or timezone

Sourcemodule Capacity : sig ... end

Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns

Sourcemodule EmailOutboundConfig : sig ... end

Default Email Outbound config

Sourcemodule EmailOutboundMode : sig ... end

Email Outbound Mode

Sourcemodule SmsOutboundConfig : sig ... end

Default SMS Outbound config

Sourcemodule SmsOutboundMode : sig ... end

SMS Outbound Mode

Sourcemodule QueueId : sig ... end

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

Sourcemodule TelephonyOutboundConfig : sig ... end

Default Telephony Outbound config

Sourcemodule TelephonyOutboundMode : sig ... end

Telephony Outbound Mode

Sourcemodule WhatsAppOutboundConfig : sig ... end

Default WhatsApp Outbound config

Sourcemodule WhatsAppOutboundMode : sig ... end

WhatsApp Outbound Mode

Sourcemodule CommunicationLimitList : sig ... end
Sourcemodule LocalTimeZoneDetection : sig ... end
Sourcemodule TimeZone : sig ... end

Time Zone Id in the IANA format

Sourcemodule OpenHours : sig ... end

Open Hours config

Sourcemodule RestrictedPeriods : sig ... end

Restricted period config

Sourcemodule ClientToken : sig ... end

Client provided parameter used for idempotency. Its value must be unique for each request.

Sourcemodule ProfileOutboundRequestId : sig ... end

Identifier of the profile outbound request

Sourcemodule ProfileId : sig ... end

Identifier of the customer profile

Sourcemodule DialRequestId : sig ... end

Identifier representing a Dial request

Sourcemodule FailureCode : sig ... end
Sourcemodule ChannelSubtypeParameters : sig ... end

ChannelSubtypeParameters for an outbound request

Customer Profiles integration summary

Sourcemodule LambdaIntegrationSummary : sig ... end

Lambda integration summary

Q Connect integration summary

Sourcemodule CampaignArn : sig ... end

The resource name of an Amazon Connect campaign.

Sourcemodule CampaignId : sig ... end

Identifier representing a Campaign

Sourcemodule CampaignName : sig ... end

The name of an Amazon Connect Campaign name.

Sourcemodule ChannelSubtypeList : sig ... end
Sourcemodule EntryLimitsConfig : sig ... end

Campaign entry limits config

Sourcemodule ExternalCampaignType : sig ... end
Sourcemodule InstanceId : sig ... end

Amazon Connect Instance Id

Sourcemodule Schedule : sig ... end

Campaign schedule

Sourcemodule InstanceIdFilterOperator : sig ... end
Sourcemodule Enabled : sig ... end

Boolean to indicate if custom encryption has been enabled.

Sourcemodule EncryptionKey : sig ... end

KMS key id/arn for encryption config.

Sourcemodule EncryptionType : sig ... end
Sourcemodule CampaignState : sig ... end
Sourcemodule EmailChannelSubtypeConfig : sig ... end

Email Channel Subtype config

Sourcemodule SmsChannelSubtypeConfig : sig ... end

SMS Channel Subtype config

Telephony Channel Subtype config

WhatsApp Channel Subtype config

Sourcemodule CommunicationLimits : sig ... end

Communication limits

Sourcemodule InstanceLimitsHandling : sig ... end
Sourcemodule LocalTimeZoneConfig : sig ... end

Local time zone config

Sourcemodule TimeWindow : sig ... end

Time window config

Sourcemodule EventTrigger : sig ... end

Event trigger of the campaign

Sourcemodule TagKey : sig ... end

The key of tag.

Sourcemodule TagValue : sig ... end

The value of tag.

Sourcemodule String_ : sig ... end
Sourcemodule XAmazonErrorType : sig ... end

A header that defines the error encountered while processing the request.

Failure details for a profile outbound request

Success details for a profile outbound request

Sourcemodule ProfileOutboundRequest : sig ... end

Information about a profile outbound request

Sourcemodule FailedRequest : sig ... end

A failed request identified by the unique client token.

Sourcemodule SuccessfulRequest : sig ... end

A successful request identified by the unique client token.

Sourcemodule OutboundRequest : sig ... end

An outbound request for a campaign.

Customer Profiles integration config

Sourcemodule LambdaIntegrationConfig : sig ... end

Lambda integration config

Sourcemodule QConnectIntegrationConfig : sig ... end

Q Connect integration config

Sourcemodule IntegrationSummary : sig ... end

Integration summary for Connect instance.

Sourcemodule CampaignSummary : sig ... end

An Amazon Connect campaign summary.

Sourcemodule InstanceIdFilter : sig ... end

Connect instance identifier filter

Sourcemodule EncryptionConfig : sig ... end

Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported

Sourcemodule ServiceLinkedRoleArn : sig ... end

Service linked role arn

Failed response of campaign state

Successful response of campaign state

Sourcemodule ChannelSubtypeConfig : sig ... end

Campaign Channel Subtype config

Sourcemodule CommunicationLimitsConfig : sig ... end

Communication limits config

Sourcemodule CommunicationTimeConfig : sig ... end

Campaign communication time config

Sourcemodule Source : sig ... end

Source of the campaign

Sourcemodule TagMap : sig ... end

Customer Profiles integration identifier

Lambda integration identifier

Q Connect integration identifier

Sourcemodule TagKeyList : sig ... end
Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule ConflictException : sig ... end

The request could not be processed because of conflict in the current state of the resource.

Instance onboarding job status object

Sourcemodule InternalServerException : sig ... end

Request processing failed because of an error or failure with the service.

Sourcemodule ResourceNotFoundException : sig ... end

The specified resource was not found.

Sourcemodule ThrottlingException : sig ... end

The request was denied due to request throttling.

Sourcemodule ValidationException : sig ... end

The input fails to satisfy the constraints specified by an AWS service.

The request could not be processed because of conflict in the current state of the campaign.

Sourcemodule FailedRequestList : sig ... end
Sourcemodule SuccessfulRequestList : sig ... end
Sourcemodule OutboundRequestList : sig ... end

Instance Communication limits config

Sourcemodule IntegrationConfig : sig ... end

Integration config for Connect Instance

Sourcemodule IntegrationSummaryList : sig ... end
Sourcemodule NextToken : sig ... end

The token for the next set of results.

Sourcemodule MaxResults : sig ... end

The maximum number of results to return per page.

Sourcemodule CampaignSummaryList : sig ... end
Sourcemodule CampaignFilters : sig ... end

Filter model by type

Sourcemodule InstanceConfig : sig ... end

Instance config object

Sourcemodule Campaign : sig ... end

An Amazon Connect campaign.

Sourcemodule IntegrationIdentifier : sig ... end

Integration identifier for Connect instance

Sourcemodule CampaignDeletionPolicy : sig ... end

Request would cause a service quota to be exceeded.

The request for UpdateCampaignSource API.

The request for UpdateCampaignSchedule API.

Sourcemodule UpdateCampaignNameRequest : sig ... end

The request for UpdateCampaignName API.

The request for UpdateCampaignFlowAssociation API.

The request for UpdateCampaignEntryLimits API.

The request for UpdateCampaignCommunicationTime API.

The request for UpdateCampaignCommunicationLimits API.

The request for UpdateCampaignChannelSubtypeConfig API.

Sourcemodule UntagResourceRequest : sig ... end

The request for UntagResource API.

Sourcemodule TagResourceRequest : sig ... end

The request for TagResource API.

Sourcemodule StopCampaignRequest : sig ... end

The request for StopCampaign API.

The response for StartInstanceOnboardingJob API.

The request for StartInstanceOnboardingJob API.

Sourcemodule StartCampaignRequest : sig ... end

The request for StartCampaign API.

Sourcemodule ResumeCampaignRequest : sig ... end

The request for ResumeCampaign API.

The response for PutProfileOutboundRequestBatch API

The request for PutProfileOutboundRequestBatch API

The response for PutOutboundRequestBatch API.

The request for PutOutboundRequestBatch API.

The request for PutInstanceCommunicationLimits API.

The request for PutConnectInstanceIntegration API.

Sourcemodule PauseCampaignRequest : sig ... end

The request for PauseCampaign API.

The request for ListTagsForResource API.

The request for ListTagsForResource API.

The response for ListConnectInstanceIntegrations API.

The request for ListConnectInstanceIntegrations API.

Sourcemodule ListCampaignsResponse : sig ... end

The response for ListCampaigns API.

Sourcemodule ListCampaignsRequest : sig ... end

The request for ListCampaigns API.

Sourcemodule InvalidStateException : sig ... end

The request could not be processed because of conflict in the current state.

The response for GetInstanceOnboardingJobStatus API.

The request for GetInstanceOnboardingJobStatus API.

The response for GetInstanceCommunicationLimits API.

The request for GetInstanceCommunicationLimits API.

The response for GetConnectInstanceConfig API.

The request for GetConnectInstanceConfig API.

Sourcemodule GetCampaignStateResponse : sig ... end

The response for GetCampaignState API.

Sourcemodule GetCampaignStateRequest : sig ... end

The request for GetCampaignState API.

The response for GetCampaignStateBatch API.

The request for GetCampaignStateBatch API.

Sourcemodule DescribeCampaignResponse : sig ... end

The response for DescribeCampaign API.

Sourcemodule DescribeCampaignRequest : sig ... end

The request for DescribeCampaign API.

The request for DeleteInstanceOnboardingJob API.

The request for DeleteConnectInstanceIntegration API.

The request for DeleteConnectInstanceConfig API.

Sourcemodule DeleteCampaignRequest : sig ... end

The request for DeleteCampaign API.

The request for DeleteCampaignEntryLimits API.

The request for DeleteCampaignCommunicationTime API.

The request for DeleteCampaignCommunicationLimits API.

The request for DeleteCampaignChannelSubtypeConfig API.

Sourcemodule CreateCampaignResponse : sig ... end

The response for Create Campaign API

Sourcemodule CreateCampaignRequest : sig ... end

The request for CreateCampaign API.