types

package
v1.11.3 Latest Latest
Warning

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

 Go to latest Published: May 16, 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 AgentlessDialerConfig added in v1.4.0 

type AgentlessDialerConfig struct {

	// Allocates dialing capacity for this campaign between multiple active campaigns
	DialingCapacity *float64
	// contains filtered or unexported fields
}

Agentless Dialer 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

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

	// The possible types of dialer config parameters
	//
	// This member is required.
	DialerConfig DialerConfig

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

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

	// The configuration used for outbound calls.
	//
	// This member is required.
	OutboundCallConfig *OutboundCallConfig

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

An Amazon Connect campaign.

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"
)

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

	// 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
	// contains filtered or unexported fields
}

An Amazon Connect campaign summary.

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 DialRequest 

type DialRequest 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

	// 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

	// The phone number of the customer, in E.164 format.
	//
	// This member is required.
	PhoneNumber *string
	// contains filtered or unexported fields
}

A dial request for a campaign.

type DialerConfig 

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

The possible types of dialer config parameters

The following types satisfy this interface: 

DialerConfigMemberAgentlessDialerConfig
DialerConfigMemberPredictiveDialerConfig
DialerConfigMemberProgressiveDialerConfig
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

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

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

	case *types.DialerConfigMemberPredictiveDialerConfig:
		_ = v.Value // Value is types.PredictiveDialerConfig

	case *types.DialerConfigMemberProgressiveDialerConfig:
		_ = v.Value // Value is types.ProgressiveDialerConfig

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

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

	}
}

var _ *types.PredictiveDialerConfig
var _ *types.AgentlessDialerConfig
var _ *types.ProgressiveDialerConfig

Output:

type DialerConfigMemberAgentlessDialerConfig added in v1.4.0 

type DialerConfigMemberAgentlessDialerConfig struct {
	Value AgentlessDialerConfig
	// contains filtered or unexported fields
}

Agentless Dialer config

type DialerConfigMemberPredictiveDialerConfig 

type DialerConfigMemberPredictiveDialerConfig struct {
	Value PredictiveDialerConfig
	// contains filtered or unexported fields
}

Predictive Dialer config

type DialerConfigMemberProgressiveDialerConfig 

type DialerConfigMemberProgressiveDialerConfig struct {
	Value ProgressiveDialerConfig
	// contains filtered or unexported fields
}

Progressive Dialer 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 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 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"
	// Request throttled due to large number of pending dial requests
	FailureCodeRequestThrottled FailureCode = "RequestThrottled"
	// Unexpected error during processing of request
	FailureCodeUnknownError FailureCode = "UnknownError"
)

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 

func (GetCampaignStateBatchFailureCode) Values() []GetCampaignStateBatchFailureCode

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 

func (InstanceIdFilterOperator) Values() []InstanceIdFilterOperator

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 

func (InstanceOnboardingJobFailureCode) Values() []InstanceOnboardingJobFailureCode

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 

func (InstanceOnboardingJobStatusCode) Values() []InstanceOnboardingJobStatusCode

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 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 (e *InvalidCampaignStateException) Error() string

func (*InvalidCampaignStateException) ErrorCode 

func (e *InvalidCampaignStateException) ErrorCode() string

func (*InvalidCampaignStateException) ErrorFault 

func (e *InvalidCampaignStateException) ErrorFault() smithy.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 OutboundCallConfig 

type OutboundCallConfig struct {

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

	// Answering Machine Detection config
	AnswerMachineDetectionConfig *AnswerMachineDetectionConfig

	// 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

	// 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
}

The configuration used for outbound calls.

type PredictiveDialerConfig 

type PredictiveDialerConfig struct {

	// The bandwidth allocation of a queue resource.
	//
	// This member is required.
	BandwidthAllocation *float64

	// Allocates dialing capacity for this campaign between multiple active campaigns
	DialingCapacity *float64
	// contains filtered or unexported fields
}

Predictive Dialer config

type ProgressiveDialerConfig 

type ProgressiveDialerConfig struct {

	// The bandwidth allocation of a queue resource.
	//
	// This member is required.
	BandwidthAllocation *float64

	// Allocates dialing capacity for this campaign between multiple active campaigns
	DialingCapacity *float64
	// contains filtered or unexported fields
}

Progressive Dialer config

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 (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

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 (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

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

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.