types

package
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string

	XAmzErrorType *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AgentlessConfig

type AgentlessConfig struct {
	// contains filtered or unexported fields
}

Agentless config

type AnswerMachineDetectionConfig

type AnswerMachineDetectionConfig struct {

	// Enable or disable answering machine detection
	//
	// This member is required.
	EnableAnswerMachineDetection *bool

	// Enable or disable await answer machine prompt
	AwaitAnswerMachinePrompt *bool
	// contains filtered or unexported fields
}

Answering Machine Detection config

type Campaign

type Campaign struct {

	// The resource name of an Amazon Connect campaign.
	//
	// This member is required.
	Arn *string

	// Campaign Channel Subtype config
	//
	// This member is required.
	ChannelSubtypeConfig *ChannelSubtypeConfig

	// Amazon Connect Instance Id
	//
	// This member is required.
	ConnectInstanceId *string

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string

	// The name of an Amazon Connect Campaign name.
	//
	// This member is required.
	Name *string

	// Communication limits config
	CommunicationLimitsOverride *CommunicationLimitsConfig

	// Campaign communication time config
	CommunicationTimeConfig *CommunicationTimeConfig

	// Amazon Resource Names(ARN)
	ConnectCampaignFlowArn *string

	// Campaign schedule
	Schedule *Schedule

	// Source of the campaign
	Source Source

	// Tag map with key and value.
	Tags map[string]string
	// contains filtered or unexported fields
}

An Amazon Connect campaign.

type CampaignDeletionPolicy

type CampaignDeletionPolicy string
const (
	CampaignDeletionPolicyRetainAll CampaignDeletionPolicy = "RETAIN_ALL"
	CampaignDeletionPolicyDeleteAll CampaignDeletionPolicy = "DELETE_ALL"
)

Enum values for CampaignDeletionPolicy

func (CampaignDeletionPolicy) Values

Values returns all known values for CampaignDeletionPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CampaignFilters

type CampaignFilters struct {

	// Connect instance identifier filter
	InstanceIdFilter *InstanceIdFilter
	// contains filtered or unexported fields
}

Filter model by type

type CampaignState

type CampaignState string
const (
	// Campaign is in initialized state
	CampaignStateInitialized CampaignState = "Initialized"
	// Campaign is in running state
	CampaignStateRunning CampaignState = "Running"
	// Campaign is in paused state
	CampaignStatePaused CampaignState = "Paused"
	// Campaign is in stopped state
	CampaignStateStopped CampaignState = "Stopped"
	// Campaign is in failed state
	CampaignStateFailed CampaignState = "Failed"
	// Campaign is in completed state
	CampaignStateCompleted CampaignState = "Completed"
)

Enum values for CampaignState

func (CampaignState) Values

func (CampaignState) Values() []CampaignState

Values returns all known values for CampaignState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CampaignSummary

type CampaignSummary struct {

	// The resource name of an Amazon Connect campaign.
	//
	// This member is required.
	Arn *string

	// Channel subtype list
	//
	// This member is required.
	ChannelSubtypes []ChannelSubtype

	// Amazon Connect Instance Id
	//
	// This member is required.
	ConnectInstanceId *string

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string

	// The name of an Amazon Connect Campaign name.
	//
	// This member is required.
	Name *string

	// Amazon Resource Names(ARN)
	ConnectCampaignFlowArn *string

	// Campaign schedule
	Schedule *Schedule
	// contains filtered or unexported fields
}

An Amazon Connect campaign summary.

type ChannelSubtype

type ChannelSubtype string
const (
	ChannelSubtypeTelephony ChannelSubtype = "TELEPHONY"
	ChannelSubtypeSms       ChannelSubtype = "SMS"
	ChannelSubtypeEmail     ChannelSubtype = "EMAIL"
)

Enum values for ChannelSubtype

func (ChannelSubtype) Values

func (ChannelSubtype) Values() []ChannelSubtype

Values returns all known values for ChannelSubtype. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChannelSubtypeConfig

type ChannelSubtypeConfig struct {

	// Email Channel Subtype config
	Email *EmailChannelSubtypeConfig

	// SMS Channel Subtype config
	Sms *SmsChannelSubtypeConfig

	// Telephony Channel Subtype config
	Telephony *TelephonyChannelSubtypeConfig
	// contains filtered or unexported fields
}

Campaign Channel Subtype config

type ChannelSubtypeParameters

type ChannelSubtypeParameters interface {
	// contains filtered or unexported methods
}

ChannelSubtypeParameters for an outbound request

The following types satisfy this interface:

ChannelSubtypeParametersMemberEmail
ChannelSubtypeParametersMemberSms
ChannelSubtypeParametersMemberTelephony
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.ChannelSubtypeParameters
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ChannelSubtypeParametersMemberEmail:
		_ = v.Value // Value is types.EmailChannelSubtypeParameters

	case *types.ChannelSubtypeParametersMemberSms:
		_ = v.Value // Value is types.SmsChannelSubtypeParameters

	case *types.ChannelSubtypeParametersMemberTelephony:
		_ = v.Value // Value is types.TelephonyChannelSubtypeParameters

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type ChannelSubtypeParametersMemberEmail

type ChannelSubtypeParametersMemberEmail struct {
	Value EmailChannelSubtypeParameters
	// contains filtered or unexported fields
}

Parameters for the Email Channel Subtype

type ChannelSubtypeParametersMemberSms

type ChannelSubtypeParametersMemberSms struct {
	Value SmsChannelSubtypeParameters
	// contains filtered or unexported fields
}

Parameters for the SMS Channel Subtype

type ChannelSubtypeParametersMemberTelephony

type ChannelSubtypeParametersMemberTelephony struct {
	Value TelephonyChannelSubtypeParameters
	// contains filtered or unexported fields
}

Parameters for the Telephony Channel Subtype

type CommunicationLimit

type CommunicationLimit struct {

	// The number of days to consider with regards to this limit.
	//
	// This member is required.
	Frequency *int32

	// Maximum number of contacts allowed for a given target within the given
	// frequency.
	//
	// This member is required.
	MaxCountPerRecipient *int32

	// The communication limit time unit.
	//
	// This member is required.
	Unit CommunicationLimitTimeUnit
	// contains filtered or unexported fields
}

Communication Limit

type CommunicationLimitTimeUnit

type CommunicationLimitTimeUnit string
const (
	CommunicationLimitTimeUnitDay CommunicationLimitTimeUnit = "DAY"
)

Enum values for CommunicationLimitTimeUnit

func (CommunicationLimitTimeUnit) Values

Values returns all known values for CommunicationLimitTimeUnit. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CommunicationLimits

type CommunicationLimits interface {
	// contains filtered or unexported methods
}

Communication limits

The following types satisfy this interface:

CommunicationLimitsMemberCommunicationLimitsList
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.CommunicationLimits
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.CommunicationLimitsMemberCommunicationLimitsList:
		_ = v.Value // Value is []types.CommunicationLimit

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type CommunicationLimitsConfig

type CommunicationLimitsConfig struct {

	// Communication limits
	AllChannelSubtypes CommunicationLimits
	// contains filtered or unexported fields
}

Communication limits config

type CommunicationLimitsConfigType

type CommunicationLimitsConfigType string
const (
	CommunicationLimitsConfigTypeAllChannelSubtypes CommunicationLimitsConfigType = "ALL_CHANNEL_SUBTYPES"
)

Enum values for CommunicationLimitsConfigType

func (CommunicationLimitsConfigType) Values

Values returns all known values for CommunicationLimitsConfigType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CommunicationLimitsMemberCommunicationLimitsList

type CommunicationLimitsMemberCommunicationLimitsList struct {
	Value []CommunicationLimit
	// contains filtered or unexported fields
}

List of communication limit

type CommunicationTimeConfig

type CommunicationTimeConfig struct {

	// Local time zone config
	//
	// This member is required.
	LocalTimeZoneConfig *LocalTimeZoneConfig

	// Time window config
	Email *TimeWindow

	// Time window config
	Sms *TimeWindow

	// Time window config
	Telephony *TimeWindow
	// contains filtered or unexported fields
}

Campaign communication time config

type CommunicationTimeConfigType

type CommunicationTimeConfigType string
const (
	CommunicationTimeConfigTypeTelephony CommunicationTimeConfigType = "TELEPHONY"
	CommunicationTimeConfigTypeSms       CommunicationTimeConfigType = "SMS"
	CommunicationTimeConfigTypeEmail     CommunicationTimeConfigType = "EMAIL"
)

Enum values for CommunicationTimeConfigType

func (CommunicationTimeConfigType) Values

Values returns all known values for CommunicationTimeConfigType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	XAmzErrorType *string
	// contains filtered or unexported fields
}

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

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type CustomerProfilesIntegrationConfig

type CustomerProfilesIntegrationConfig struct {

	// Amazon Resource Names(ARN)
	//
	// This member is required.
	DomainArn *string

	// Object type names map.
	//
	// This member is required.
	ObjectTypeNames map[string]string
	// contains filtered or unexported fields
}

Customer Profiles integration config

type CustomerProfilesIntegrationIdentifier

type CustomerProfilesIntegrationIdentifier struct {

	// Amazon Resource Names(ARN)
	//
	// This member is required.
	DomainArn *string
	// contains filtered or unexported fields
}

Customer Profiles integration identifier

type CustomerProfilesIntegrationSummary

type CustomerProfilesIntegrationSummary struct {

	// Amazon Resource Names(ARN)
	//
	// This member is required.
	DomainArn *string

	// Object type names map.
	//
	// This member is required.
	ObjectTypeNames map[string]string
	// contains filtered or unexported fields
}

Customer Profiles integration summary

type DayOfWeek

type DayOfWeek string
const (
	DayOfWeekMonday    DayOfWeek = "MONDAY"
	DayOfWeekTuesday   DayOfWeek = "TUESDAY"
	DayOfWeekWednesday DayOfWeek = "WEDNESDAY"
	DayOfWeekThursday  DayOfWeek = "THURSDAY"
	DayOfWeekFriday    DayOfWeek = "FRIDAY"
	DayOfWeekSaturday  DayOfWeek = "SATURDAY"
	DayOfWeekSunday    DayOfWeek = "SUNDAY"
)

Enum values for DayOfWeek

func (DayOfWeek) Values

func (DayOfWeek) Values() []DayOfWeek

Values returns all known values for DayOfWeek. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EmailChannelSubtypeConfig

type EmailChannelSubtypeConfig struct {

	// Default Email Outbound config
	//
	// This member is required.
	DefaultOutboundConfig *EmailOutboundConfig

	// Email Outbound Mode
	//
	// This member is required.
	OutboundMode EmailOutboundMode

	// Allocates outbound capacity for the specific channel subtype of this campaign
	// between multiple active campaigns
	Capacity *float64
	// contains filtered or unexported fields
}

Email Channel Subtype config

type EmailChannelSubtypeParameters

type EmailChannelSubtypeParameters struct {

	// Source/Destination Email address used for Email messages
	//
	// This member is required.
	DestinationEmailAddress *string

	// A custom key-value pair using an attribute map. The attributes are standard
	// Amazon Connect attributes, and can be accessed in contact flows just like any
	// other contact attributes.
	//
	// This member is required.
	TemplateParameters map[string]string

	// Source/Destination Email address used for Email messages
	ConnectSourceEmailAddress *string

	// Amazon Resource Names(ARN)
	TemplateArn *string
	// contains filtered or unexported fields
}

Parameters for the Email Channel Subtype

type EmailOutboundConfig

type EmailOutboundConfig struct {

	// Source/Destination Email address used for Email messages
	//
	// This member is required.
	ConnectSourceEmailAddress *string

	// Amazon Resource Names(ARN)
	//
	// This member is required.
	WisdomTemplateArn *string

	// Display name for Email Address
	SourceEmailAddressDisplayName *string
	// contains filtered or unexported fields
}

Default Email Outbound config

type EmailOutboundMode

type EmailOutboundMode interface {
	// contains filtered or unexported methods
}

Email Outbound Mode

The following types satisfy this interface:

EmailOutboundModeMemberAgentless
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.EmailOutboundMode
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.EmailOutboundModeMemberAgentless:
		_ = v.Value // Value is types.AgentlessConfig

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type EmailOutboundModeMemberAgentless

type EmailOutboundModeMemberAgentless struct {
	Value AgentlessConfig
	// contains filtered or unexported fields
}

Agentless config

type EncryptionConfig

type EncryptionConfig struct {

	// Boolean to indicate if custom encryption has been enabled.
	//
	// This member is required.
	Enabled bool

	// Server-side encryption type.
	EncryptionType EncryptionType

	// KMS key id/arn for encryption config.
	KeyArn *string
	// contains filtered or unexported fields
}

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

type EncryptionType

type EncryptionType string
const (
	EncryptionTypeKms EncryptionType = "KMS"
)

Enum values for EncryptionType

func (EncryptionType) Values

func (EncryptionType) Values() []EncryptionType

Values returns all known values for EncryptionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EventTrigger added in v1.1.0

type EventTrigger struct {

	// Amazon Resource Names(ARN)
	CustomerProfilesDomainArn *string
	// contains filtered or unexported fields
}

Event trigger of the campaign

type EventType

type EventType string
const (
	EventTypeCampaignEmail         EventType = "Campaign-Email"
	EventTypeCampaignSms           EventType = "Campaign-SMS"
	EventTypeCampaignTelephony     EventType = "Campaign-Telephony"
	EventTypeCampaignOrchestration EventType = "Campaign-Orchestration"
)

Enum values for EventType

func (EventType) Values

func (EventType) Values() []EventType

Values returns all known values for EventType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FailedCampaignStateResponse

type FailedCampaignStateResponse struct {

	// Identifier representing a Campaign
	CampaignId *string

	// A predefined code indicating the error that caused the failure in getting state
	// of campaigns
	FailureCode GetCampaignStateBatchFailureCode
	// contains filtered or unexported fields
}

Failed response of campaign state

type FailedProfileOutboundRequest added in v1.1.0

type FailedProfileOutboundRequest struct {

	// Client provided parameter used for idempotency. Its value must be unique for
	// each request.
	ClientToken *string

	// Predefined code indicating the error that caused the failure
	FailureCode ProfileOutboundRequestFailureCode

	// Identifier of the profile outbound request
	Id *string
	// contains filtered or unexported fields
}

Failure details for a profile outbound request

type FailedRequest

type FailedRequest struct {

	// Client provided parameter used for idempotency. Its value must be unique for
	// each request.
	ClientToken *string

	// A predefined code indicating the error that caused the failure.
	FailureCode FailureCode

	// Identifier representing a Dial request
	Id *string
	// contains filtered or unexported fields
}

A failed request identified by the unique client token.

type FailureCode

type FailureCode string
const (
	// The request failed to satisfy the constraints specified by the service
	FailureCodeInvalidInput FailureCode = "InvalidInput"
	// The request was throttled due to excessive usage
	FailureCodeRequestThrottled FailureCode = "RequestThrottled"
	// Unexpected error during processing of request
	FailureCodeUnknownError FailureCode = "UnknownError"
	// Request throttled due to large number of pending dial requests
	FailureCodeBufferLimitExceeded FailureCode = "BufferLimitExceeded"
)

Enum values for FailureCode

func (FailureCode) Values

func (FailureCode) Values() []FailureCode

Values returns all known values for FailureCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GetCampaignStateBatchFailureCode

type GetCampaignStateBatchFailureCode string
const (
	// The specified resource was not found
	GetCampaignStateBatchFailureCodeResourceNotFound GetCampaignStateBatchFailureCode = "ResourceNotFound"
	// Unexpected error during processing of request
	GetCampaignStateBatchFailureCodeUnknownError GetCampaignStateBatchFailureCode = "UnknownError"
)

Enum values for GetCampaignStateBatchFailureCode

func (GetCampaignStateBatchFailureCode) Values

Values returns all known values for GetCampaignStateBatchFailureCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InstanceConfig

type InstanceConfig struct {

	// Amazon Connect Instance Id
	//
	// This member is required.
	ConnectInstanceId *string

	// 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
	//
	// This member is required.
	EncryptionConfig *EncryptionConfig

	// Service linked role arn
	//
	// This member is required.
	ServiceLinkedRoleArn *string
	// contains filtered or unexported fields
}

Instance config object

type InstanceIdFilter

type InstanceIdFilter struct {

	// Operators for Connect instance identifier filter
	//
	// This member is required.
	Operator InstanceIdFilterOperator

	// Amazon Connect Instance Id
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Connect instance identifier filter

type InstanceIdFilterOperator

type InstanceIdFilterOperator string
const (
	// Equals operator
	InstanceIdFilterOperatorEq InstanceIdFilterOperator = "Eq"
)

Enum values for InstanceIdFilterOperator

func (InstanceIdFilterOperator) Values

Values returns all known values for InstanceIdFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InstanceOnboardingJobFailureCode

type InstanceOnboardingJobFailureCode string
const (
	InstanceOnboardingJobFailureCodeEventBridgeAccessDenied             InstanceOnboardingJobFailureCode = "EVENT_BRIDGE_ACCESS_DENIED"
	InstanceOnboardingJobFailureCodeEventBridgeManagedRuleLimitExceeded InstanceOnboardingJobFailureCode = "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED"
	InstanceOnboardingJobFailureCodeIamAccessDenied                     InstanceOnboardingJobFailureCode = "IAM_ACCESS_DENIED"
	InstanceOnboardingJobFailureCodeKmsAccessDenied                     InstanceOnboardingJobFailureCode = "KMS_ACCESS_DENIED"
	InstanceOnboardingJobFailureCodeKmsKeyNotFound                      InstanceOnboardingJobFailureCode = "KMS_KEY_NOT_FOUND"
	InstanceOnboardingJobFailureCodeInternalFailure                     InstanceOnboardingJobFailureCode = "INTERNAL_FAILURE"
)

Enum values for InstanceOnboardingJobFailureCode

func (InstanceOnboardingJobFailureCode) Values

Values returns all known values for InstanceOnboardingJobFailureCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InstanceOnboardingJobStatus

type InstanceOnboardingJobStatus struct {

	// Amazon Connect Instance Id
	//
	// This member is required.
	ConnectInstanceId *string

	// Enumeration of the possible states for instance onboarding job
	//
	// This member is required.
	Status InstanceOnboardingJobStatusCode

	// Enumeration of the possible failure codes for instance onboarding job
	FailureCode InstanceOnboardingJobFailureCode
	// contains filtered or unexported fields
}

Instance onboarding job status object

type InstanceOnboardingJobStatusCode

type InstanceOnboardingJobStatusCode string
const (
	InstanceOnboardingJobStatusCodeInProgress InstanceOnboardingJobStatusCode = "IN_PROGRESS"
	InstanceOnboardingJobStatusCodeSucceeded  InstanceOnboardingJobStatusCode = "SUCCEEDED"
	InstanceOnboardingJobStatusCodeFailed     InstanceOnboardingJobStatusCode = "FAILED"
)

Enum values for InstanceOnboardingJobStatusCode

func (InstanceOnboardingJobStatusCode) Values

Values returns all known values for InstanceOnboardingJobStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IntegrationConfig

type IntegrationConfig interface {
	// contains filtered or unexported methods
}

Integration config for Connect Instance

The following types satisfy this interface:

IntegrationConfigMemberCustomerProfiles
IntegrationConfigMemberQConnect
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.IntegrationConfig
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.IntegrationConfigMemberCustomerProfiles:
		_ = v.Value // Value is types.CustomerProfilesIntegrationConfig

	case *types.IntegrationConfigMemberQConnect:
		_ = v.Value // Value is types.QConnectIntegrationConfig

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type IntegrationConfigMemberCustomerProfiles

type IntegrationConfigMemberCustomerProfiles struct {
	Value CustomerProfilesIntegrationConfig
	// contains filtered or unexported fields
}

Customer Profiles integration config

type IntegrationConfigMemberQConnect

type IntegrationConfigMemberQConnect struct {
	Value QConnectIntegrationConfig
	// contains filtered or unexported fields
}

Q Connect integration config

type IntegrationIdentifier

type IntegrationIdentifier interface {
	// contains filtered or unexported methods
}

Integration identifier for Connect instance

The following types satisfy this interface:

IntegrationIdentifierMemberCustomerProfiles
IntegrationIdentifierMemberQConnect
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.IntegrationIdentifier
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.IntegrationIdentifierMemberCustomerProfiles:
		_ = v.Value // Value is types.CustomerProfilesIntegrationIdentifier

	case *types.IntegrationIdentifierMemberQConnect:
		_ = v.Value // Value is types.QConnectIntegrationIdentifier

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type IntegrationIdentifierMemberCustomerProfiles

type IntegrationIdentifierMemberCustomerProfiles struct {
	Value CustomerProfilesIntegrationIdentifier
	// contains filtered or unexported fields
}

Customer Profiles integration identifier

type IntegrationIdentifierMemberQConnect

type IntegrationIdentifierMemberQConnect struct {
	Value QConnectIntegrationIdentifier
	// contains filtered or unexported fields
}

Q Connect integration identifier

type IntegrationSummary

type IntegrationSummary interface {
	// contains filtered or unexported methods
}

Integration summary for Connect instance.

The following types satisfy this interface:

IntegrationSummaryMemberCustomerProfiles
IntegrationSummaryMemberQConnect
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.IntegrationSummary
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.IntegrationSummaryMemberCustomerProfiles:
		_ = v.Value // Value is types.CustomerProfilesIntegrationSummary

	case *types.IntegrationSummaryMemberQConnect:
		_ = v.Value // Value is types.QConnectIntegrationSummary

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type IntegrationSummaryMemberCustomerProfiles

type IntegrationSummaryMemberCustomerProfiles struct {
	Value CustomerProfilesIntegrationSummary
	// contains filtered or unexported fields
}

Customer Profiles integration summary

type IntegrationSummaryMemberQConnect

type IntegrationSummaryMemberQConnect struct {
	Value QConnectIntegrationSummary
	// contains filtered or unexported fields
}

Q Connect integration summary

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	XAmzErrorType *string
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type InvalidCampaignStateException

type InvalidCampaignStateException struct {
	Message *string

	ErrorCodeOverride *string

	State         CampaignState
	XAmzErrorType *string
	// contains filtered or unexported fields
}

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

func (*InvalidCampaignStateException) Error

func (*InvalidCampaignStateException) ErrorCode

func (e *InvalidCampaignStateException) ErrorCode() string

func (*InvalidCampaignStateException) ErrorFault

func (*InvalidCampaignStateException) ErrorMessage

func (e *InvalidCampaignStateException) ErrorMessage() string

type InvalidStateException

type InvalidStateException struct {
	Message *string

	ErrorCodeOverride *string

	XAmzErrorType *string
	// contains filtered or unexported fields
}

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

func (*InvalidStateException) Error

func (e *InvalidStateException) Error() string

func (*InvalidStateException) ErrorCode

func (e *InvalidStateException) ErrorCode() string

func (*InvalidStateException) ErrorFault

func (e *InvalidStateException) ErrorFault() smithy.ErrorFault

func (*InvalidStateException) ErrorMessage

func (e *InvalidStateException) ErrorMessage() string

type LocalTimeZoneConfig

type LocalTimeZoneConfig struct {

	// Time Zone Id in the IANA format
	DefaultTimeZone *string

	// Local TimeZone Detection method list
	LocalTimeZoneDetection []LocalTimeZoneDetectionType
	// contains filtered or unexported fields
}

Local time zone config

type LocalTimeZoneDetectionType

type LocalTimeZoneDetectionType string
const (
	LocalTimeZoneDetectionTypeZipCode  LocalTimeZoneDetectionType = "ZIP_CODE"
	LocalTimeZoneDetectionTypeAreaCode LocalTimeZoneDetectionType = "AREA_CODE"
)

Enum values for LocalTimeZoneDetectionType

func (LocalTimeZoneDetectionType) Values

Values returns all known values for LocalTimeZoneDetectionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpenHours

type OpenHours interface {
	// contains filtered or unexported methods
}

Open Hours config

The following types satisfy this interface:

OpenHoursMemberDailyHours
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.OpenHours
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.OpenHoursMemberDailyHours:
		_ = v.Value // Value is map[string][]types.TimeRange

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type OpenHoursMemberDailyHours

type OpenHoursMemberDailyHours struct {
	Value map[string][]TimeRange
	// contains filtered or unexported fields
}

Daily Hours map

type OutboundRequest

type OutboundRequest struct {

	// ChannelSubtypeParameters for an outbound request
	//
	// This member is required.
	ChannelSubtypeParameters ChannelSubtypeParameters

	// Client provided parameter used for idempotency. Its value must be unique for
	// each request.
	//
	// This member is required.
	ClientToken *string

	// Timestamp with no UTC offset or timezone
	//
	// This member is required.
	ExpirationTime *time.Time
	// contains filtered or unexported fields
}

An outbound request for a campaign.

type PredictiveConfig

type PredictiveConfig struct {

	// The bandwidth allocation of a queue resource.
	//
	// This member is required.
	BandwidthAllocation *float64
	// contains filtered or unexported fields
}

Predictive config

type ProfileOutboundRequest added in v1.1.0

type ProfileOutboundRequest struct {

	// Client provided parameter used for idempotency. Its value must be unique for
	// each request.
	//
	// This member is required.
	ClientToken *string

	// Identifier of the customer profile
	//
	// This member is required.
	ProfileId *string

	// Timestamp with no UTC offset or timezone
	ExpirationTime *time.Time
	// contains filtered or unexported fields
}

Information about a profile outbound request

type ProfileOutboundRequestFailureCode added in v1.1.0

type ProfileOutboundRequestFailureCode string
const (
	// Unexpected error during processing of request
	ProfileOutboundRequestFailureCodeUnknownError ProfileOutboundRequestFailureCode = "UnknownError"
	// The specified resource was not found
	ProfileOutboundRequestFailureCodeResourceNotFound ProfileOutboundRequestFailureCode = "ResourceNotFound"
	// The specified resource conflicts with another resource
	ProfileOutboundRequestFailureCodeConflict ProfileOutboundRequestFailureCode = "Conflict"
	// Request throttled due to large number of requests
	ProfileOutboundRequestFailureCodeRequestThrottled ProfileOutboundRequestFailureCode = "RequestThrottled"
	// The request failed to satisfy the constraints specified by the service
	ProfileOutboundRequestFailureCodeInvalidInput ProfileOutboundRequestFailureCode = "InvalidInput"
)

Enum values for ProfileOutboundRequestFailureCode

func (ProfileOutboundRequestFailureCode) Values added in v1.1.0

Values returns all known values for ProfileOutboundRequestFailureCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProgressiveConfig

type ProgressiveConfig struct {

	// The bandwidth allocation of a queue resource.
	//
	// This member is required.
	BandwidthAllocation *float64
	// contains filtered or unexported fields
}

Progressive config

type QConnectIntegrationConfig

type QConnectIntegrationConfig struct {

	// Amazon Resource Names(ARN)
	//
	// This member is required.
	KnowledgeBaseArn *string
	// contains filtered or unexported fields
}

Q Connect integration config

type QConnectIntegrationIdentifier

type QConnectIntegrationIdentifier struct {

	// Amazon Resource Names(ARN)
	//
	// This member is required.
	KnowledgeBaseArn *string
	// contains filtered or unexported fields
}

Q Connect integration identifier

type QConnectIntegrationSummary

type QConnectIntegrationSummary struct {

	// Amazon Resource Names(ARN)
	//
	// This member is required.
	KnowledgeBaseArn *string
	// contains filtered or unexported fields
}

Q Connect integration summary

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	XAmzErrorType *string
	// contains filtered or unexported fields
}

The specified resource was not found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type RestrictedPeriod

type RestrictedPeriod struct {

	// Date in ISO 8601 format, e.g. 2024-01-01
	//
	// This member is required.
	EndDate *string

	// Date in ISO 8601 format, e.g. 2024-01-01
	//
	// This member is required.
	StartDate *string

	// The name of a restricted period.
	Name *string
	// contains filtered or unexported fields
}

Restricted period

type RestrictedPeriods

type RestrictedPeriods interface {
	// contains filtered or unexported methods
}

Restricted period config

The following types satisfy this interface:

RestrictedPeriodsMemberRestrictedPeriodList
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.RestrictedPeriods
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.RestrictedPeriodsMemberRestrictedPeriodList:
		_ = v.Value // Value is []types.RestrictedPeriod

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type RestrictedPeriodsMemberRestrictedPeriodList

type RestrictedPeriodsMemberRestrictedPeriodList struct {
	Value []RestrictedPeriod
	// contains filtered or unexported fields
}

List of restricted period

type Schedule

type Schedule struct {

	// Timestamp with no UTC offset or timezone
	//
	// This member is required.
	EndTime *time.Time

	// Timestamp with no UTC offset or timezone
	//
	// This member is required.
	StartTime *time.Time

	// Time duration in ISO 8601 format
	RefreshFrequency *string
	// contains filtered or unexported fields
}

Campaign schedule

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	XAmzErrorType *string
	// contains filtered or unexported fields
}

Request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Error

func (*ServiceQuotaExceededException) ErrorCode

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SmsChannelSubtypeConfig

type SmsChannelSubtypeConfig struct {

	// Default SMS Outbound config
	//
	// This member is required.
	DefaultOutboundConfig *SmsOutboundConfig

	// SMS Outbound Mode
	//
	// This member is required.
	OutboundMode SmsOutboundMode

	// Allocates outbound capacity for the specific channel subtype of this campaign
	// between multiple active campaigns
	Capacity *float64
	// contains filtered or unexported fields
}

SMS Channel Subtype config

type SmsChannelSubtypeParameters

type SmsChannelSubtypeParameters struct {

	// The phone number of the customer, in E.164 format.
	//
	// This member is required.
	DestinationPhoneNumber *string

	// A custom key-value pair using an attribute map. The attributes are standard
	// Amazon Connect attributes, and can be accessed in contact flows just like any
	// other contact attributes.
	//
	// This member is required.
	TemplateParameters map[string]string

	// Amazon Resource Names(ARN)
	ConnectSourcePhoneNumberArn *string

	// Amazon Resource Names(ARN)
	TemplateArn *string
	// contains filtered or unexported fields
}

Parameters for the SMS Channel Subtype

type SmsOutboundConfig

type SmsOutboundConfig struct {

	// Amazon Resource Names(ARN)
	//
	// This member is required.
	ConnectSourcePhoneNumberArn *string

	// Amazon Resource Names(ARN)
	//
	// This member is required.
	WisdomTemplateArn *string
	// contains filtered or unexported fields
}

Default SMS Outbound config

type SmsOutboundMode

type SmsOutboundMode interface {
	// contains filtered or unexported methods
}

SMS Outbound Mode

The following types satisfy this interface:

SmsOutboundModeMemberAgentless
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.SmsOutboundMode
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SmsOutboundModeMemberAgentless:
		_ = v.Value // Value is types.AgentlessConfig

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type SmsOutboundModeMemberAgentless

type SmsOutboundModeMemberAgentless struct {
	Value AgentlessConfig
	// contains filtered or unexported fields
}

Agentless config

type Source

type Source interface {
	// contains filtered or unexported methods
}

Source of the campaign

The following types satisfy this interface:

SourceMemberCustomerProfilesSegmentArn
SourceMemberEventTrigger
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.Source
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SourceMemberCustomerProfilesSegmentArn:
		_ = v.Value // Value is string

	case *types.SourceMemberEventTrigger:
		_ = v.Value // Value is types.EventTrigger

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type SourceMemberCustomerProfilesSegmentArn

type SourceMemberCustomerProfilesSegmentArn struct {
	Value string
	// contains filtered or unexported fields
}

Amazon Resource Names(ARN)

type SourceMemberEventTrigger added in v1.1.0

type SourceMemberEventTrigger struct {
	Value EventTrigger
	// contains filtered or unexported fields
}

Event trigger of the campaign

type SuccessfulCampaignStateResponse

type SuccessfulCampaignStateResponse struct {

	// Identifier representing a Campaign
	CampaignId *string

	// State of a campaign
	State CampaignState
	// contains filtered or unexported fields
}

Successful response of campaign state

type SuccessfulProfileOutboundRequest added in v1.1.0

type SuccessfulProfileOutboundRequest struct {

	// Client provided parameter used for idempotency. Its value must be unique for
	// each request.
	ClientToken *string

	// Identifier of the profile outbound request
	Id *string
	// contains filtered or unexported fields
}

Success details for a profile outbound request

type SuccessfulRequest

type SuccessfulRequest struct {

	// Client provided parameter used for idempotency. Its value must be unique for
	// each request.
	ClientToken *string

	// Identifier representing a Dial request
	Id *string
	// contains filtered or unexported fields
}

A successful request identified by the unique client token.

type TelephonyChannelSubtypeConfig

type TelephonyChannelSubtypeConfig struct {

	// Default Telephony Outbound config
	//
	// This member is required.
	DefaultOutboundConfig *TelephonyOutboundConfig

	// Telephony Outbound Mode
	//
	// This member is required.
	OutboundMode TelephonyOutboundMode

	// Allocates outbound capacity for the specific channel subtype of this campaign
	// between multiple active campaigns
	Capacity *float64

	// 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.
	ConnectQueueId *string
	// contains filtered or unexported fields
}

Telephony Channel Subtype config

type TelephonyChannelSubtypeParameters

type TelephonyChannelSubtypeParameters struct {

	// A custom key-value pair using an attribute map. The attributes are standard
	// Amazon Connect attributes, and can be accessed in contact flows just like any
	// other contact attributes.
	//
	// This member is required.
	Attributes map[string]string

	// The phone number of the customer, in E.164 format.
	//
	// This member is required.
	DestinationPhoneNumber *string

	// Answering Machine Detection config
	AnswerMachineDetectionConfig *AnswerMachineDetectionConfig

	// 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.
	ConnectSourcePhoneNumber *string
	// contains filtered or unexported fields
}

Parameters for the Telephony Channel Subtype

type TelephonyOutboundConfig

type TelephonyOutboundConfig struct {

	// The identifier of the contact flow for the outbound call.
	//
	// This member is required.
	ConnectContactFlowId *string

	// Answering Machine Detection config
	AnswerMachineDetectionConfig *AnswerMachineDetectionConfig

	// 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.
	ConnectSourcePhoneNumber *string
	// contains filtered or unexported fields
}

Default Telephony Outbound config

type TelephonyOutboundMode

type TelephonyOutboundMode interface {
	// contains filtered or unexported methods
}

Telephony Outbound Mode

The following types satisfy this interface:

TelephonyOutboundModeMemberAgentless
TelephonyOutboundModeMemberPredictive
TelephonyOutboundModeMemberProgressive
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/connectcampaignsv2/types"
)

func main() {
	var union types.TelephonyOutboundMode
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TelephonyOutboundModeMemberAgentless:
		_ = v.Value // Value is types.AgentlessConfig

	case *types.TelephonyOutboundModeMemberPredictive:
		_ = v.Value // Value is types.PredictiveConfig

	case *types.TelephonyOutboundModeMemberProgressive:
		_ = v.Value // Value is types.ProgressiveConfig

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type TelephonyOutboundModeMemberAgentless

type TelephonyOutboundModeMemberAgentless struct {
	Value AgentlessConfig
	// contains filtered or unexported fields
}

Agentless config

type TelephonyOutboundModeMemberPredictive

type TelephonyOutboundModeMemberPredictive struct {
	Value PredictiveConfig
	// contains filtered or unexported fields
}

Predictive config

type TelephonyOutboundModeMemberProgressive

type TelephonyOutboundModeMemberProgressive struct {
	Value ProgressiveConfig
	// contains filtered or unexported fields
}

Progressive config

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	XAmzErrorType *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type TimeRange

type TimeRange struct {

	// Time in ISO 8601 format, e.g. T23:11
	//
	// This member is required.
	EndTime *string

	// Time in ISO 8601 format, e.g. T23:11
	//
	// This member is required.
	StartTime *string
	// contains filtered or unexported fields
}

Time range in 24 hour format

type TimeWindow

type TimeWindow struct {

	// Open Hours config
	//
	// This member is required.
	OpenHours OpenHours

	// Restricted period config
	RestrictedPeriods RestrictedPeriods
	// contains filtered or unexported fields
}

Time window config

type UnknownUnionMember

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	XAmzErrorType *string
	// contains filtered or unexported fields
}

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

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL