connectcampaigns

package module
v1.15.15 Latest Latest
Warning

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

 Go to latest Published: Jan 31, 2025 License: Apache-2.0 Imports: 44 Imported by: 7

Documentation

Overview

Package connectcampaigns provides the API client, operations, and parameter types for AmazonConnectCampaignService.

Provide APIs to create and manage Amazon Connect Campaigns.

Index

Constants

View Source 
const ServiceAPIVersion = "2021-01-30"
View Source 
const ServiceID = "ConnectCampaigns"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.3.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.6.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.6.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.6.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.6.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for AmazonConnectCampaignService.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateCampaign 

func (c *Client) CreateCampaign(ctx context.Context, params *CreateCampaignInput, optFns ...func(*Options)) (*CreateCampaignOutput, error)

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

func (*Client) DeleteCampaign 

func (c *Client) DeleteCampaign(ctx context.Context, params *DeleteCampaignInput, optFns ...func(*Options)) (*DeleteCampaignOutput, error)

Deletes a campaign from the specified Amazon Connect account.

func (*Client) DeleteConnectInstanceConfig 

func (c *Client) DeleteConnectInstanceConfig(ctx context.Context, params *DeleteConnectInstanceConfigInput, optFns ...func(*Options)) (*DeleteConnectInstanceConfigOutput, error)

Deletes a connect instance config from the specified AWS account.

func (*Client) DeleteInstanceOnboardingJob 

func (c *Client) DeleteInstanceOnboardingJob(ctx context.Context, params *DeleteInstanceOnboardingJobInput, optFns ...func(*Options)) (*DeleteInstanceOnboardingJobOutput, error)

Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.

func (*Client) DescribeCampaign 

func (c *Client) DescribeCampaign(ctx context.Context, params *DescribeCampaignInput, optFns ...func(*Options)) (*DescribeCampaignOutput, error)

Describes the specific campaign.

func (*Client) GetCampaignState 

func (c *Client) GetCampaignState(ctx context.Context, params *GetCampaignStateInput, optFns ...func(*Options)) (*GetCampaignStateOutput, error)

Get state of a campaign for the specified Amazon Connect account.

func (*Client) GetCampaignStateBatch 

func (c *Client) GetCampaignStateBatch(ctx context.Context, params *GetCampaignStateBatchInput, optFns ...func(*Options)) (*GetCampaignStateBatchOutput, error)

Get state of campaigns for the specified Amazon Connect account.

func (*Client) GetConnectInstanceConfig 

func (c *Client) GetConnectInstanceConfig(ctx context.Context, params *GetConnectInstanceConfigInput, optFns ...func(*Options)) (*GetConnectInstanceConfigOutput, error)

Get the specific Connect instance config.

func (*Client) GetInstanceOnboardingJobStatus 

func (c *Client) GetInstanceOnboardingJobStatus(ctx context.Context, params *GetInstanceOnboardingJobStatusInput, optFns ...func(*Options)) (*GetInstanceOnboardingJobStatusOutput, error)

Get the specific instance onboarding job status.

func (*Client) ListCampaigns 

func (c *Client) ListCampaigns(ctx context.Context, params *ListCampaignsInput, optFns ...func(*Options)) (*ListCampaignsOutput, error)

Provides summary information about the campaigns under the specified Amazon Connect account.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List tags for a resource.

func (*Client) Options added in v1.7.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PauseCampaign 

func (c *Client) PauseCampaign(ctx context.Context, params *PauseCampaignInput, optFns ...func(*Options)) (*PauseCampaignOutput, error)

Pauses a campaign for the specified Amazon Connect account.

func (*Client) PutDialRequestBatch 

func (c *Client) PutDialRequestBatch(ctx context.Context, params *PutDialRequestBatchInput, optFns ...func(*Options)) (*PutDialRequestBatchOutput, error)

Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.

func (*Client) ResumeCampaign 

func (c *Client) ResumeCampaign(ctx context.Context, params *ResumeCampaignInput, optFns ...func(*Options)) (*ResumeCampaignOutput, error)

Stops a campaign for the specified Amazon Connect account.

func (*Client) StartCampaign 

func (c *Client) StartCampaign(ctx context.Context, params *StartCampaignInput, optFns ...func(*Options)) (*StartCampaignOutput, error)

Starts a campaign for the specified Amazon Connect account.

func (*Client) StartInstanceOnboardingJob 

func (c *Client) StartInstanceOnboardingJob(ctx context.Context, params *StartInstanceOnboardingJobInput, optFns ...func(*Options)) (*StartInstanceOnboardingJobOutput, error)

Onboard the specific Amazon Connect instance to Connect Campaigns.

func (*Client) StopCampaign 

func (c *Client) StopCampaign(ctx context.Context, params *StopCampaignInput, optFns ...func(*Options)) (*StopCampaignOutput, error)

Stops a campaign for the specified Amazon Connect account.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Tag a resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Untag a resource.

func (*Client) UpdateCampaignDialerConfig 

func (c *Client) UpdateCampaignDialerConfig(ctx context.Context, params *UpdateCampaignDialerConfigInput, optFns ...func(*Options)) (*UpdateCampaignDialerConfigOutput, error)

Updates the dialer config of a campaign. This API is idempotent.

func (*Client) UpdateCampaignName 

func (c *Client) UpdateCampaignName(ctx context.Context, params *UpdateCampaignNameInput, optFns ...func(*Options)) (*UpdateCampaignNameOutput, error)

Updates the name of a campaign. This API is idempotent.

func (*Client) UpdateCampaignOutboundCallConfig 

func (c *Client) UpdateCampaignOutboundCallConfig(ctx context.Context, params *UpdateCampaignOutboundCallConfigInput, optFns ...func(*Options)) (*UpdateCampaignOutboundCallConfigOutput, error)

Updates the outbound call config of a campaign. This API is idempotent.

type CreateCampaignInput 

type CreateCampaignInput struct {

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

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

	// 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 *types.OutboundCallConfig

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

The request for Create Campaign API.

type CreateCampaignOutput 

type CreateCampaignOutput struct {

	// The resource name of an Amazon Connect campaign.
	Arn *string

	// Identifier representing a Campaign
	Id *string

	// Tag map with key and value.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response for Create Campaign API

type DeleteCampaignInput 

type DeleteCampaignInput struct {

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

DeleteCampaignRequest

type DeleteCampaignOutput 

type DeleteCampaignOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteConnectInstanceConfigInput 

type DeleteConnectInstanceConfigInput struct {

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

DeleteCampaignRequest

type DeleteConnectInstanceConfigOutput 

type DeleteConnectInstanceConfigOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteInstanceOnboardingJobInput 

type DeleteInstanceOnboardingJobInput struct {

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

The request for DeleteInstanceOnboardingJob API.

type DeleteInstanceOnboardingJobOutput 

type DeleteInstanceOnboardingJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCampaignInput 

type DescribeCampaignInput struct {

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

DescribeCampaignRequests

type DescribeCampaignOutput 

type DescribeCampaignOutput struct {

	// An Amazon Connect campaign.
	Campaign *types.Campaign

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

DescribeCampaignResponse

type EndpointParameters added in v1.3.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.3.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.3.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.3.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.3.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCampaignStateBatchInput 

type GetCampaignStateBatchInput struct {

	// List of CampaignId
	//
	// This member is required.
	CampaignIds []string
	// contains filtered or unexported fields
}

GetCampaignStateBatchRequest

type GetCampaignStateBatchOutput 

type GetCampaignStateBatchOutput struct {

	// List of failed requests of campaign state
	FailedRequests []types.FailedCampaignStateResponse

	// List of successful response of campaign state
	SuccessfulRequests []types.SuccessfulCampaignStateResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

GetCampaignStateBatchResponse

type GetCampaignStateInput 

type GetCampaignStateInput struct {

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

GetCampaignStateRequest

type GetCampaignStateOutput 

type GetCampaignStateOutput struct {

	// State of a campaign
	State types.CampaignState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

GetCampaignStateResponse

type GetConnectInstanceConfigInput 

type GetConnectInstanceConfigInput struct {

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

GetConnectInstanceConfigRequest

type GetConnectInstanceConfigOutput 

type GetConnectInstanceConfigOutput struct {

	// Instance config object
	ConnectInstanceConfig *types.InstanceConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

GetConnectInstanceConfigResponse

type GetInstanceOnboardingJobStatusInput 

type GetInstanceOnboardingJobStatusInput struct {

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

GetInstanceOnboardingJobStatusRequest

type GetInstanceOnboardingJobStatusOutput 

type GetInstanceOnboardingJobStatusOutput struct {

	// Instance onboarding job status object
	ConnectInstanceOnboardingJobStatus *types.InstanceOnboardingJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

GetInstanceOnboardingJobStatusResponse

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListCampaignsAPIClient 

type ListCampaignsAPIClient interface {
	ListCampaigns(context.Context, *ListCampaignsInput, ...func(*Options)) (*ListCampaignsOutput, error)
}

ListCampaignsAPIClient is a client that implements the ListCampaigns operation.

type ListCampaignsInput 

type ListCampaignsInput struct {

	// Filter model by type
	Filters *types.CampaignFilters

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

ListCampaignsRequest

type ListCampaignsOutput 

type ListCampaignsOutput struct {

	// A list of Amazon Connect campaigns.
	CampaignSummaryList []types.CampaignSummary

	// The token for the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

ListCampaignsResponse

type ListCampaignsPaginator 

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

ListCampaignsPaginator is a paginator for ListCampaigns

func NewListCampaignsPaginator 

func NewListCampaignsPaginator(client ListCampaignsAPIClient, params *ListCampaignsInput, optFns ...func(*ListCampaignsPaginatorOptions)) *ListCampaignsPaginator

NewListCampaignsPaginator returns a new ListCampaignsPaginator

func (*ListCampaignsPaginator) HasMorePages 

func (p *ListCampaignsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCampaignsPaginator) NextPage 

func (p *ListCampaignsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCampaignsOutput, error)

NextPage retrieves the next ListCampaigns page.

type ListCampaignsPaginatorOptions 

type ListCampaignsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCampaignsPaginatorOptions is the paginator options for ListCampaigns

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// Arn
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

ListTagsForResource

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Tag map with key and value.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

ListTagsForResponse

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.6.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PauseCampaignInput 

type PauseCampaignInput struct {

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

PauseCampaignRequest

type PauseCampaignOutput 

type PauseCampaignOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutDialRequestBatchInput 

type PutDialRequestBatchInput struct {

	// A list of dial requests.
	//
	// This member is required.
	DialRequests []types.DialRequest

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

PutDialRequestBatchRequest

type PutDialRequestBatchOutput 

type PutDialRequestBatchOutput struct {

	// A list of failed requests.
	FailedRequests []types.FailedRequest

	// A list of successful requests identified by the unique client token.
	SuccessfulRequests []types.SuccessfulRequest

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

PutDialRequestBatchResponse

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type ResumeCampaignInput 

type ResumeCampaignInput struct {

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

ResumeCampaignRequest

type ResumeCampaignOutput 

type ResumeCampaignOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartCampaignInput 

type StartCampaignInput struct {

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

StartCampaignRequest

type StartCampaignOutput 

type StartCampaignOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartInstanceOnboardingJobInput 

type StartInstanceOnboardingJobInput 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 *types.EncryptionConfig
	// contains filtered or unexported fields
}

The request for StartInstanceOnboardingJob API.

type StartInstanceOnboardingJobOutput 

type StartInstanceOnboardingJobOutput struct {

	// Instance onboarding job status object
	ConnectInstanceOnboardingJobStatus *types.InstanceOnboardingJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response for StartInstanceOnboardingJob API.

type StopCampaignInput 

type StopCampaignInput struct {

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

StopCampaignRequest

type StopCampaignOutput 

type StopCampaignOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// Arn
	//
	// This member is required.
	Arn *string

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

TagResourceRequest

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// Arn
	//
	// This member is required.
	Arn *string

	// List of tag keys.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

UntagResourceRequest

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCampaignDialerConfigInput 

type UpdateCampaignDialerConfigInput struct {

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

	// Identifier representing a Campaign
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

UpdateCampaignDialerConfigRequest

type UpdateCampaignDialerConfigOutput 

type UpdateCampaignDialerConfigOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCampaignNameInput 

type UpdateCampaignNameInput struct {

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

UpdateCampaignNameRequest

type UpdateCampaignNameOutput 

type UpdateCampaignNameOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCampaignOutboundCallConfigInput 

type UpdateCampaignOutboundCallConfigInput struct {

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

	// Answering Machine Detection config
	AnswerMachineDetectionConfig *types.AnswerMachineDetectionConfig

	// The identifier of the contact flow for the outbound call.
	ConnectContactFlowId *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
}

UpdateCampaignOutboundCallConfigRequest

type UpdateCampaignOutboundCallConfigOutput 

type UpdateCampaignOutboundCallConfigOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.