connect

package module
v1.96.0 Latest Latest
Warning

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

 Go to latest Published: Apr 10, 2024 License: Apache-2.0 Imports: 42 Imported by: 7

Documentation

Overview

Package connect provides the API client, operations, and parameter types for Amazon Connect Service.

Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale. Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents. There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the Amazon Connect Administrator Guide. You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints (https://docs.aws.amazon.com/general/latest/gr/connect_region.html) .

Index

Constants

View Source 
const ServiceAPIVersion = "2017-08-08"
View Source 
const ServiceID = "Connect"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.80.1 

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

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 ActivateEvaluationFormInput added in v1.53.0 

type ActivateEvaluationFormInput struct {

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

	// The version of the evaluation form to activate. If the version property is not
	// provided, the latest version of the evaluation form is activated.
	//
	// This member is required.
	EvaluationFormVersion int32

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type ActivateEvaluationFormOutput added in v1.53.0 

type ActivateEvaluationFormOutput struct {

	// The Amazon Resource Name (ARN) for the evaluation form resource.
	//
	// This member is required.
	EvaluationFormArn *string

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

	// A version of the evaluation form.
	//
	// This member is required.
	EvaluationFormVersion int32

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

type AssociateAnalyticsDataSetInput added in v1.82.0 

type AssociateAnalyticsDataSetInput struct {

	// The identifier of the dataset to associate with the target account.
	//
	// This member is required.
	DataSetId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the target account. Use to associate a dataset to a different
	// account than the one containing the Amazon Connect instance. If not specified,
	// by default this value is the Amazon Web Services account that has the Amazon
	// Connect instance.
	TargetAccountId *string
	// contains filtered or unexported fields
}

type AssociateAnalyticsDataSetOutput added in v1.82.0 

type AssociateAnalyticsDataSetOutput struct {

	// The identifier of the dataset that was associated.
	DataSetId *string

	// The Amazon Resource Name (ARN) of the Resource Access Manager share.
	ResourceShareArn *string

	// The Resource Access Manager share ID that is generated.
	ResourceShareId *string

	// The identifier of the target account.
	TargetAccountId *string

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

type AssociateApprovedOriginInput added in v0.30.0 

type AssociateApprovedOriginInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The domain to add to your allow list.
	//
	// This member is required.
	Origin *string
	// contains filtered or unexported fields
}

type AssociateApprovedOriginOutput added in v0.30.0 

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

type AssociateBotInput added in v1.5.0 

type AssociateBotInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Configuration information of an Amazon Lex bot.
	LexBot *types.LexBot

	// The Amazon Lex V2 bot to associate with the instance.
	LexV2Bot *types.LexV2Bot
	// contains filtered or unexported fields
}

type AssociateBotOutput added in v1.5.0 

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

type AssociateDefaultVocabularyInput added in v1.17.0 

type AssociateDefaultVocabularyInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The language code of the vocabulary entries. For a list of languages and their
	// corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)
	//
	// This member is required.
	LanguageCode types.VocabularyLanguageCode

	// The identifier of the custom vocabulary. If this is empty, the default is set
	// to none.
	VocabularyId *string
	// contains filtered or unexported fields
}

type AssociateDefaultVocabularyOutput added in v1.17.0 

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

type AssociateFlowInput added in v1.82.0 

type AssociateFlowInput struct {

	// The identifier of the flow.
	//
	// This member is required.
	FlowId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the resource.
	//
	// This member is required.
	ResourceId *string

	// A valid resource type.
	//
	// This member is required.
	ResourceType types.FlowAssociationResourceType
	// contains filtered or unexported fields
}

type AssociateFlowOutput added in v1.82.0 

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

type AssociateInstanceStorageConfigInput added in v0.30.0 

type AssociateInstanceStorageConfigInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A valid resource type. To enable streaming for real-time analysis of contacts (https://docs.aws.amazon.com/connect/latest/adminguide/enable-contact-analysis-segment-streams.html)
	// , use the following types:
	//   - For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS .
	//   - For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS .
	// REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported
	// and will apply only to VOICE channel contacts. Use
	// REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward. If
	// you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
	// , no action is needed to update the stream to
	// REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS .
	//
	// This member is required.
	ResourceType types.InstanceStorageResourceType

	// A valid storage type.
	//
	// This member is required.
	StorageConfig *types.InstanceStorageConfig
	// contains filtered or unexported fields
}

type AssociateInstanceStorageConfigOutput added in v0.30.0 

type AssociateInstanceStorageConfigOutput struct {

	// The existing association identifier that uniquely identifies the resource type
	// and storage config for the given instance ID.
	AssociationId *string

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

type AssociateLambdaFunctionInput added in v0.30.0 

type AssociateLambdaFunctionInput struct {

	// The Amazon Resource Name (ARN) for the Lambda function being associated.
	// Maximum number of characters allowed is 140.
	//
	// This member is required.
	FunctionArn *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type AssociateLambdaFunctionOutput added in v0.30.0 

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

type AssociateLexBotInput added in v0.30.0 

type AssociateLexBotInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The Amazon Lex bot to associate with the instance.
	//
	// This member is required.
	LexBot *types.LexBot
	// contains filtered or unexported fields
}

type AssociateLexBotOutput added in v0.30.0 

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

type AssociatePhoneNumberContactFlowInput added in v1.22.0 

type AssociatePhoneNumberContactFlowInput struct {

	// The identifier of the flow.
	//
	// This member is required.
	ContactFlowId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the phone number.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type AssociatePhoneNumberContactFlowOutput added in v1.22.0 

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

type AssociateQueueQuickConnectsInput added in v1.2.0 

type AssociateQueueQuickConnectsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string

	// The quick connects to associate with this queue.
	//
	// This member is required.
	QuickConnectIds []string
	// contains filtered or unexported fields
}

type AssociateQueueQuickConnectsOutput added in v1.2.0 

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

type AssociateRoutingProfileQueuesInput added in v0.29.0 

type AssociateRoutingProfileQueuesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The queues to associate with this routing profile.
	//
	// This member is required.
	QueueConfigs []types.RoutingProfileQueueConfig

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string
	// contains filtered or unexported fields
}

type AssociateRoutingProfileQueuesOutput added in v0.29.0 

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

type AssociateSecurityKeyInput added in v0.30.0 

type AssociateSecurityKeyInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A valid security key in PEM format.
	//
	// This member is required.
	Key *string
	// contains filtered or unexported fields
}

type AssociateSecurityKeyOutput added in v0.30.0 

type AssociateSecurityKeyOutput struct {

	// The existing association identifier that uniquely identifies the resource type
	// and storage config for the given instance ID.
	AssociationId *string

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

type AssociateTrafficDistributionGroupUserInput added in v1.65.0 

type AssociateTrafficDistributionGroupUserInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the traffic distribution group. This can be the ID or the ARN
	// if the API is being called in the Region where the traffic distribution group
	// was created. The ARN must be provided if the call is from the replicated Region.
	//
	// This member is required.
	TrafficDistributionGroupId *string

	// The identifier of the user account. This can be the ID or the ARN of the user.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type AssociateTrafficDistributionGroupUserOutput added in v1.65.0 

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

type AssociateUserProficienciesInput added in v1.87.0 

type AssociateUserProficienciesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN of the instance).
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string

	// The proficiencies to associate with the user.
	//
	// This member is required.
	UserProficiencies []types.UserProficiency
	// contains filtered or unexported fields
}

type AssociateUserProficienciesOutput added in v1.87.0 

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

type AuthResolverParameters added in v1.80.1 

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

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

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

type BatchAssociateAnalyticsDataSetInput added in v1.82.0 

type BatchAssociateAnalyticsDataSetInput struct {

	// An array of dataset identifiers to associate.
	//
	// This member is required.
	DataSetIds []string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the target account. Use to associate a dataset to a different
	// account than the one containing the Amazon Connect instance. If not specified,
	// by default this value is the Amazon Web Services account that has the Amazon
	// Connect instance.
	TargetAccountId *string
	// contains filtered or unexported fields
}

type BatchAssociateAnalyticsDataSetOutput added in v1.82.0 

type BatchAssociateAnalyticsDataSetOutput struct {

	// Information about associations that are successfully created: DataSetId ,
	// TargetAccountId , ResourceShareId , ResourceShareArn .
	Created []types.AnalyticsDataAssociationResult

	// A list of errors for datasets that aren't successfully associated with the
	// target account.
	Errors []types.ErrorResult

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

type BatchDisassociateAnalyticsDataSetInput added in v1.82.0 

type BatchDisassociateAnalyticsDataSetInput struct {

	// An array of associated dataset identifiers to remove.
	//
	// This member is required.
	DataSetIds []string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the target account. Use to disassociate a dataset from a
	// different account than the one containing the Amazon Connect instance. If not
	// specified, by default this value is the Amazon Web Services account that has the
	// Amazon Connect instance.
	TargetAccountId *string
	// contains filtered or unexported fields
}

type BatchDisassociateAnalyticsDataSetOutput added in v1.82.0 

type BatchDisassociateAnalyticsDataSetOutput struct {

	// An array of successfully disassociated dataset identifiers.
	Deleted []string

	// A list of errors for any datasets not successfully removed.
	Errors []types.ErrorResult

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

type BatchGetFlowAssociationInput added in v1.74.0 

type BatchGetFlowAssociationInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A list of resource identifiers to retrieve flow associations.
	//
	// This member is required.
	ResourceIds []string

	// The type of resource association.
	ResourceType types.ListFlowAssociationResourceType
	// contains filtered or unexported fields
}

type BatchGetFlowAssociationOutput added in v1.74.0 

type BatchGetFlowAssociationOutput struct {

	// Information about flow associations.
	FlowAssociationSummaryList []types.FlowAssociationSummary

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

type BatchPutContactInput added in v1.77.0 

type BatchPutContactInput struct {

	// List of individual contact requests.
	//
	// This member is required.
	ContactDataRequestList []types.ContactDataRequest

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type BatchPutContactOutput added in v1.77.0 

type BatchPutContactOutput struct {

	// List of requests for which contact creation failed.
	FailedRequestList []types.FailedRequest

	// List of requests for which contact was successfully created.
	SuccessfulRequestList []types.SuccessfulRequest

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

type ClaimPhoneNumberInput added in v1.22.0 

type ClaimPhoneNumberInput struct {

	// The phone number you want to claim. Phone numbers are formatted [+] [country
	// code] [subscriber number including area code] .
	//
	// This member is required.
	PhoneNumber *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// . Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
	ClientToken *string

	// The identifier of the Amazon Connect instance that phone numbers are claimed
	// to. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or
	// TargetArn .
	InstanceId *string

	// The description of the phone number.
	PhoneNumberDescription *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string

	// The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
	// distribution groups that phone number inbound traffic is routed through. You
	// must enter InstanceId or TargetArn .
	TargetArn *string
	// contains filtered or unexported fields
}

type ClaimPhoneNumberOutput added in v1.22.0 

type ClaimPhoneNumberOutput struct {

	// The Amazon Resource Name (ARN) of the phone number.
	PhoneNumberArn *string

	// A unique identifier for the phone number.
	PhoneNumberId *string

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

type Client 

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

Client provides the API client to make operations call for Amazon Connect Service.

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) ActivateEvaluationForm added in v1.53.0 

func (c *Client) ActivateEvaluationForm(ctx context.Context, params *ActivateEvaluationFormInput, optFns ...func(*Options)) (*ActivateEvaluationFormOutput, error)

Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.

func (*Client) AssociateAnalyticsDataSet added in v1.82.0 

func (c *Client) AssociateAnalyticsDataSet(ctx context.Context, params *AssociateAnalyticsDataSetInput, optFns ...func(*Options)) (*AssociateAnalyticsDataSetOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

func (*Client) AssociateApprovedOrigin added in v0.30.0 

func (c *Client) AssociateApprovedOrigin(ctx context.Context, params *AssociateApprovedOriginInput, optFns ...func(*Options)) (*AssociateApprovedOriginOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance.

func (*Client) AssociateBot added in v1.5.0 

func (c *Client) AssociateBot(ctx context.Context, params *AssociateBotInput, optFns ...func(*Options)) (*AssociateBotOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

func (*Client) AssociateDefaultVocabulary added in v1.17.0 

func (c *Client) AssociateDefaultVocabulary(ctx context.Context, params *AssociateDefaultVocabularyInput, optFns ...func(*Options)) (*AssociateDefaultVocabularyOutput, error)

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

func (*Client) AssociateFlow added in v1.82.0 

func (c *Client) AssociateFlow(ctx context.Context, params *AssociateFlowInput, optFns ...func(*Options)) (*AssociateFlowOutput, error)

Associates a connect resource to a flow.

func (*Client) AssociateInstanceStorageConfig added in v0.30.0 

func (c *Client) AssociateInstanceStorageConfig(ctx context.Context, params *AssociateInstanceStorageConfigInput, optFns ...func(*Options)) (*AssociateInstanceStorageConfigOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

func (*Client) AssociateLambdaFunction added in v0.30.0 

func (c *Client) AssociateLambdaFunction(ctx context.Context, params *AssociateLambdaFunctionInput, optFns ...func(*Options)) (*AssociateLambdaFunctionOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Lambda function.

func (*Client) AssociateLexBot added in v0.30.0 

func (c *Client) AssociateLexBot(ctx context.Context, params *AssociateLexBotInput, optFns ...func(*Options)) (*AssociateLexBotOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.

func (*Client) AssociatePhoneNumberContactFlow added in v1.22.0 

func (c *Client) AssociatePhoneNumberContactFlow(ctx context.Context, params *AssociatePhoneNumberContactFlowInput, optFns ...func(*Options)) (*AssociatePhoneNumberContactFlowOutput, error)

Associates a flow with a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException .

func (*Client) AssociateQueueQuickConnects added in v1.2.0 

func (c *Client) AssociateQueueQuickConnects(ctx context.Context, params *AssociateQueueQuickConnectsInput, optFns ...func(*Options)) (*AssociateQueueQuickConnectsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Associates a set of quick connects with a queue.

func (*Client) AssociateRoutingProfileQueues added in v0.29.0 

func (c *Client) AssociateRoutingProfileQueues(ctx context.Context, params *AssociateRoutingProfileQueuesInput, optFns ...func(*Options)) (*AssociateRoutingProfileQueuesOutput, error)

Associates a set of queues with a routing profile.

func (*Client) AssociateSecurityKey added in v0.30.0 

func (c *Client) AssociateSecurityKey(ctx context.Context, params *AssociateSecurityKeyInput, optFns ...func(*Options)) (*AssociateSecurityKeyOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance.

func (*Client) AssociateTrafficDistributionGroupUser added in v1.65.0 

func (c *Client) AssociateTrafficDistributionGroupUser(ctx context.Context, params *AssociateTrafficDistributionGroupUserInput, optFns ...func(*Options)) (*AssociateTrafficDistributionGroupUserOutput, error)

Associates an agent with a traffic distribution group.

func (*Client) AssociateUserProficiencies added in v1.87.0 

func (c *Client) AssociateUserProficiencies(ctx context.Context, params *AssociateUserProficienciesInput, optFns ...func(*Options)) (*AssociateUserProficienciesOutput, error)

>Associates a set of proficiencies with a user.

func (*Client) BatchAssociateAnalyticsDataSet added in v1.82.0 

func (c *Client) BatchAssociateAnalyticsDataSet(ctx context.Context, params *BatchAssociateAnalyticsDataSetInput, optFns ...func(*Options)) (*BatchAssociateAnalyticsDataSetOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

func (*Client) BatchDisassociateAnalyticsDataSet added in v1.82.0 

func (c *Client) BatchDisassociateAnalyticsDataSet(ctx context.Context, params *BatchDisassociateAnalyticsDataSetInput, optFns ...func(*Options)) (*BatchDisassociateAnalyticsDataSetOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

func (*Client) BatchGetFlowAssociation added in v1.74.0 

func (c *Client) BatchGetFlowAssociation(ctx context.Context, params *BatchGetFlowAssociationInput, optFns ...func(*Options)) (*BatchGetFlowAssociationOutput, error)

Retrieve the flow associations for the given resources.

func (*Client) BatchPutContact added in v1.77.0 

func (c *Client) BatchPutContact(ctx context.Context, params *BatchPutContactInput, optFns ...func(*Options)) (*BatchPutContactOutput, error)

Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch (https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_PutDialRequestBatch.html) API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

func (*Client) ClaimPhoneNumber added in v1.22.0 

func (c *Client) ClaimPhoneNumber(ctx context.Context, params *ClaimPhoneNumberInput, optFns ...func(*Options)) (*ClaimPhoneNumberOutput, error)

Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country (https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-number.html) and Claim phone numbers to traffic distribution groups (https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-numbers-traffic-distribution-groups.html) in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers (https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html) API for available phone numbers that you can claim. Call the DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) API to verify the status of a previous ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html) operation. If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

func (*Client) CreateAgentStatus added in v1.6.0 

func (c *Client) CreateAgentStatus(ctx context.Context, params *CreateAgentStatusInput, optFns ...func(*Options)) (*CreateAgentStatusOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Creates an agent status for the specified Amazon Connect instance.

func (*Client) CreateContactFlow added in v0.29.0 

func (c *Client) CreateContactFlow(ctx context.Context, params *CreateContactFlowInput, optFns ...func(*Options)) (*CreateContactFlowOutput, error)

Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) .

func (*Client) CreateContactFlowModule added in v1.13.0 

func (c *Client) CreateContactFlowModule(ctx context.Context, params *CreateContactFlowModuleInput, optFns ...func(*Options)) (*CreateContactFlowModuleOutput, error)

Creates a flow module for the specified Amazon Connect instance.

func (*Client) CreateEvaluationForm added in v1.53.0 

func (c *Client) CreateEvaluationForm(ctx context.Context, params *CreateEvaluationFormInput, optFns ...func(*Options)) (*CreateEvaluationFormOutput, error)

Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

func (*Client) CreateHoursOfOperation added in v1.6.0 

func (c *Client) CreateHoursOfOperation(ctx context.Context, params *CreateHoursOfOperationInput, optFns ...func(*Options)) (*CreateHoursOfOperationOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Creates hours of operation.

func (*Client) CreateInstance added in v0.30.0 

func (c *Client) CreateInstance(ctx context.Context, params *CreateInstanceInput, optFns ...func(*Options)) (*CreateInstanceOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

func (*Client) CreateIntegrationAssociation added in v0.31.0 

func (c *Client) CreateIntegrationAssociation(ctx context.Context, params *CreateIntegrationAssociationInput, optFns ...func(*Options)) (*CreateIntegrationAssociationOutput, error)

Creates an Amazon Web Services resource association with an Amazon Connect instance.

func (*Client) CreateParticipant added in v1.52.0 

func (c *Client) CreateParticipant(ctx context.Context, params *CreateParticipantInput, optFns ...func(*Options)) (*CreateParticipantOutput, error)

Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants (https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html) .

func (*Client) CreatePersistentContactAssociation added in v1.76.0 

func (c *Client) CreatePersistentContactAssociation(ctx context.Context, params *CreatePersistentContactAssociationInput, optFns ...func(*Options)) (*CreatePersistentContactAssociationOutput, error)

Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html) in the Amazon Connect Administrator Guide.

func (*Client) CreatePredefinedAttribute added in v1.87.0 

func (c *Client) CreatePredefinedAttribute(ctx context.Context, params *CreatePredefinedAttributeInput, optFns ...func(*Options)) (*CreatePredefinedAttributeOutput, error)

Creates a new predefined attribute for the specified Amazon Connect instance.

func (*Client) CreatePrompt added in v1.55.0 

func (c *Client) CreatePrompt(ctx context.Context, params *CreatePromptInput, optFns ...func(*Options)) (*CreatePromptOutput, error)

Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts (https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html) in the Amazon Connect Administrator's Guide.

func (*Client) CreateQueue added in v1.2.0 

func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optFns ...func(*Options)) (*CreateQueueOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance.

  • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId . However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException .
  • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you call the ListPhoneNumbersV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) API.
  • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region) .

func (*Client) CreateQuickConnect added in v0.31.0 

func (c *Client) CreateQuickConnect(ctx context.Context, params *CreateQuickConnectInput, optFns ...func(*Options)) (*CreateQuickConnectOutput, error)

Creates a quick connect for the specified Amazon Connect instance.

func (*Client) CreateRoutingProfile added in v0.29.0 

func (c *Client) CreateRoutingProfile(ctx context.Context, params *CreateRoutingProfileInput, optFns ...func(*Options)) (*CreateRoutingProfileOutput, error)

Creates a new routing profile.

func (*Client) CreateRule added in v1.39.0 

func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error)

Creates a rule for the specified Amazon Connect instance. Use the Rules Function language (https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html) to code conditions for the rule.

func (*Client) CreateSecurityProfile added in v1.11.0 

func (c *Client) CreateSecurityProfile(ctx context.Context, params *CreateSecurityProfileInput, optFns ...func(*Options)) (*CreateSecurityProfileOutput, error)

Creates a security profile.

func (*Client) CreateTaskTemplate added in v1.25.0 

func (c *Client) CreateTaskTemplate(ctx context.Context, params *CreateTaskTemplateInput, optFns ...func(*Options)) (*CreateTaskTemplateOutput, error)

Creates a new task template in the specified Amazon Connect instance.

func (*Client) CreateTrafficDistributionGroup added in v1.33.0 

func (c *Client) CreateTrafficDistributionGroup(ctx context.Context, params *CreateTrafficDistributionGroupInput, optFns ...func(*Options)) (*CreateTrafficDistributionGroupOutput, error)

Creates a traffic distribution group given an Amazon Connect instance that has been replicated. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html) data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup , an InvalidRequestException is returned. For more information about creating traffic distribution groups, see Set up traffic distribution groups (https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html) in the Amazon Connect Administrator Guide.

func (*Client) CreateUseCase added in v0.31.0 

func (c *Client) CreateUseCase(ctx context.Context, params *CreateUseCaseInput, optFns ...func(*Options)) (*CreateUseCaseOutput, error)

Creates a use case for an integration association.

func (*Client) CreateUser 

func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)

Creates a user account for the specified Amazon Connect instance. Certain UserIdentityInfo (https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html) parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management. For information about how to create users using the Amazon Connect admin website, see Add Users (https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) in the Amazon Connect Administrator Guide.

func (*Client) CreateUserHierarchyGroup added in v0.30.0 

func (c *Client) CreateUserHierarchyGroup(ctx context.Context, params *CreateUserHierarchyGroupInput, optFns ...func(*Options)) (*CreateUserHierarchyGroupOutput, error)

Creates a new user hierarchy group.

func (*Client) CreateView added in v1.66.0 

func (c *Client) CreateView(ctx context.Context, params *CreateViewInput, optFns ...func(*Options)) (*CreateViewOutput, error)

Creates a new view with the possible status of SAVED or PUBLISHED . The views will have a unique name for each connect instance. It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED . An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

func (*Client) CreateViewVersion added in v1.66.0 

func (c *Client) CreateViewVersion(ctx context.Context, params *CreateViewVersionInput, optFns ...func(*Options)) (*CreateViewVersionOutput, error)

Publishes a new version of the view identifier. Versions are immutable and monotonically increasing. It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

func (*Client) CreateVocabulary added in v1.17.0 

func (c *Client) CreateVocabulary(ctx context.Context, params *CreateVocabularyInput, optFns ...func(*Options)) (*CreateVocabularyOutput, error)

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

func (*Client) DeactivateEvaluationForm added in v1.53.0 

func (c *Client) DeactivateEvaluationForm(ctx context.Context, params *DeactivateEvaluationFormInput, optFns ...func(*Options)) (*DeactivateEvaluationFormOutput, error)

Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

func (*Client) DeleteContactEvaluation added in v1.53.0 

func (c *Client) DeleteContactEvaluation(ctx context.Context, params *DeleteContactEvaluationInput, optFns ...func(*Options)) (*DeleteContactEvaluationOutput, error)

Deletes a contact evaluation in the specified Amazon Connect instance.

func (*Client) DeleteContactFlow added in v1.13.0 

func (c *Client) DeleteContactFlow(ctx context.Context, params *DeleteContactFlowInput, optFns ...func(*Options)) (*DeleteContactFlowOutput, error)

Deletes a flow for the specified Amazon Connect instance.

func (*Client) DeleteContactFlowModule added in v1.13.0 

func (c *Client) DeleteContactFlowModule(ctx context.Context, params *DeleteContactFlowModuleInput, optFns ...func(*Options)) (*DeleteContactFlowModuleOutput, error)

Deletes the specified flow module.

func (*Client) DeleteEvaluationForm added in v1.53.0 

func (c *Client) DeleteEvaluationForm(ctx context.Context, params *DeleteEvaluationFormInput, optFns ...func(*Options)) (*DeleteEvaluationFormOutput, error)

Deletes an evaluation form in the specified Amazon Connect instance.

  • If the version property is provided, only the specified version of the evaluation form is deleted.
  • If no version is provided, then the full form (all versions) is deleted.

func (*Client) DeleteHoursOfOperation added in v1.6.0 

func (c *Client) DeleteHoursOfOperation(ctx context.Context, params *DeleteHoursOfOperationInput, optFns ...func(*Options)) (*DeleteHoursOfOperationOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Deletes an hours of operation.

func (*Client) DeleteInstance added in v0.30.0 

func (c *Client) DeleteInstance(ctx context.Context, params *DeleteInstanceInput, optFns ...func(*Options)) (*DeleteInstanceOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

func (*Client) DeleteIntegrationAssociation added in v0.31.0 

func (c *Client) DeleteIntegrationAssociation(ctx context.Context, params *DeleteIntegrationAssociationInput, optFns ...func(*Options)) (*DeleteIntegrationAssociationOutput, error)

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.

func (*Client) DeletePredefinedAttribute added in v1.87.0 

func (c *Client) DeletePredefinedAttribute(ctx context.Context, params *DeletePredefinedAttributeInput, optFns ...func(*Options)) (*DeletePredefinedAttributeOutput, error)

Deletes a predefined attribute from the specified Amazon Connect instance.

func (*Client) DeletePrompt added in v1.55.0 

func (c *Client) DeletePrompt(ctx context.Context, params *DeletePromptInput, optFns ...func(*Options)) (*DeletePromptOutput, error)

Deletes a prompt.

func (*Client) DeleteQueue added in v1.61.0 

func (c *Client) DeleteQueue(ctx context.Context, params *DeleteQueueInput, optFns ...func(*Options)) (*DeleteQueueOutput, error)

Deletes a queue.

func (*Client) DeleteQuickConnect added in v0.31.0 

func (c *Client) DeleteQuickConnect(ctx context.Context, params *DeleteQuickConnectInput, optFns ...func(*Options)) (*DeleteQuickConnectOutput, error)

Deletes a quick connect. After calling DeleteUser (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteUser.html) , it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

func (*Client) DeleteRoutingProfile added in v1.61.0 

func (c *Client) DeleteRoutingProfile(ctx context.Context, params *DeleteRoutingProfileInput, optFns ...func(*Options)) (*DeleteRoutingProfileOutput, error)

Deletes a routing profile.

func (*Client) DeleteRule added in v1.39.0 

func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error)

Deletes a rule for the specified Amazon Connect instance.

func (*Client) DeleteSecurityProfile added in v1.11.0 

func (c *Client) DeleteSecurityProfile(ctx context.Context, params *DeleteSecurityProfileInput, optFns ...func(*Options)) (*DeleteSecurityProfileOutput, error)

Deletes a security profile.

func (*Client) DeleteTaskTemplate added in v1.25.0 

func (c *Client) DeleteTaskTemplate(ctx context.Context, params *DeleteTaskTemplateInput, optFns ...func(*Options)) (*DeleteTaskTemplateOutput, error)

Deletes the task template.

func (*Client) DeleteTrafficDistributionGroup added in v1.33.0 

func (c *Client) DeleteTrafficDistributionGroup(ctx context.Context, params *DeleteTrafficDistributionGroupInput, optFns ...func(*Options)) (*DeleteTrafficDistributionGroupOutput, error)

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups (https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html) in the Amazon Connect Administrator Guide.

func (*Client) DeleteUseCase added in v0.31.0 

func (c *Client) DeleteUseCase(ctx context.Context, params *DeleteUseCaseInput, optFns ...func(*Options)) (*DeleteUseCaseOutput, error)

Deletes a use case from an integration association.

func (*Client) DeleteUser 

func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)

Deletes a user account from the specified Amazon Connect instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance (https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html) in the Amazon Connect Administrator Guide. After calling DeleteUser, call DeleteQuickConnect (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteQuickConnect.html) to delete any records related to the deleted users. This will help you:

func (*Client) DeleteUserHierarchyGroup added in v0.30.0 

func (c *Client) DeleteUserHierarchyGroup(ctx context.Context, params *DeleteUserHierarchyGroupInput, optFns ...func(*Options)) (*DeleteUserHierarchyGroupOutput, error)

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

func (*Client) DeleteView added in v1.66.0 

func (c *Client) DeleteView(ctx context.Context, params *DeleteViewInput, optFns ...func(*Options)) (*DeleteViewOutput, error)

Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

func (*Client) DeleteViewVersion added in v1.66.0 

func (c *Client) DeleteViewVersion(ctx context.Context, params *DeleteViewVersionInput, optFns ...func(*Options)) (*DeleteViewVersionOutput, error)

Deletes the particular version specified in ViewVersion identifier.

func (*Client) DeleteVocabulary added in v1.17.0 

func (c *Client) DeleteVocabulary(ctx context.Context, params *DeleteVocabularyInput, optFns ...func(*Options)) (*DeleteVocabularyOutput, error)

Deletes the vocabulary that has the given identifier.

func (*Client) DescribeAgentStatus added in v1.6.0 

func (c *Client) DescribeAgentStatus(ctx context.Context, params *DescribeAgentStatusInput, optFns ...func(*Options)) (*DescribeAgentStatusOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Describes an agent status.

func (*Client) DescribeContact added in v1.12.0 

func (c *Client) DescribeContact(ctx context.Context, params *DescribeContactInput, optFns ...func(*Options)) (*DescribeContactOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Contact information remains available in Amazon Connect for 24 months, and then it is deleted. Only data from November 12, 2021, and later is returned by this API.

func (*Client) DescribeContactEvaluation added in v1.53.0 

func (c *Client) DescribeContactEvaluation(ctx context.Context, params *DescribeContactEvaluationInput, optFns ...func(*Options)) (*DescribeContactEvaluationOutput, error)

Describes a contact evaluation in the specified Amazon Connect instance.

func (*Client) DescribeContactFlow added in v0.29.0 

func (c *Client) DescribeContactFlow(ctx context.Context, params *DescribeContactFlowInput, optFns ...func(*Options)) (*DescribeContactFlowOutput, error)

Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) .

func (*Client) DescribeContactFlowModule added in v1.13.0 

func (c *Client) DescribeContactFlowModule(ctx context.Context, params *DescribeContactFlowModuleInput, optFns ...func(*Options)) (*DescribeContactFlowModuleOutput, error)

Describes the specified flow module.

func (*Client) DescribeEvaluationForm added in v1.53.0 

func (c *Client) DescribeEvaluationForm(ctx context.Context, params *DescribeEvaluationFormInput, optFns ...func(*Options)) (*DescribeEvaluationFormOutput, error)

Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

func (*Client) DescribeHoursOfOperation added in v1.2.0 

func (c *Client) DescribeHoursOfOperation(ctx context.Context, params *DescribeHoursOfOperationInput, optFns ...func(*Options)) (*DescribeHoursOfOperationOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Describes the hours of operation.

func (*Client) DescribeInstance added in v0.30.0 

func (c *Client) DescribeInstance(ctx context.Context, params *DescribeInstanceInput, optFns ...func(*Options)) (*DescribeInstanceOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

func (*Client) DescribeInstanceAttribute added in v0.30.0 

func (c *Client) DescribeInstanceAttribute(ctx context.Context, params *DescribeInstanceAttributeInput, optFns ...func(*Options)) (*DescribeInstanceAttributeOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute.

func (*Client) DescribeInstanceStorageConfig added in v0.30.0 

func (c *Client) DescribeInstanceStorageConfig(ctx context.Context, params *DescribeInstanceStorageConfigInput, optFns ...func(*Options)) (*DescribeInstanceStorageConfigOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

func (*Client) DescribePhoneNumber added in v1.22.0 

func (c *Client) DescribePhoneNumber(ctx context.Context, params *DescribePhoneNumberInput, optFns ...func(*Options)) (*DescribePhoneNumberOutput, error)

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group. If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException .

func (*Client) DescribePredefinedAttribute added in v1.87.0 

func (c *Client) DescribePredefinedAttribute(ctx context.Context, params *DescribePredefinedAttributeInput, optFns ...func(*Options)) (*DescribePredefinedAttributeOutput, error)

Describes a predefined attribute for the specified Amazon Connect instance.

func (*Client) DescribePrompt added in v1.55.0 

func (c *Client) DescribePrompt(ctx context.Context, params *DescribePromptInput, optFns ...func(*Options)) (*DescribePromptOutput, error)

Describes the prompt.

func (*Client) DescribeQueue added in v1.2.0 

func (c *Client) DescribeQueue(ctx context.Context, params *DescribeQueueInput, optFns ...func(*Options)) (*DescribeQueueOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue.

func (*Client) DescribeQuickConnect added in v0.31.0 

func (c *Client) DescribeQuickConnect(ctx context.Context, params *DescribeQuickConnectInput, optFns ...func(*Options)) (*DescribeQuickConnectOutput, error)

Describes the quick connect.

func (*Client) DescribeRoutingProfile added in v0.29.0 

func (c *Client) DescribeRoutingProfile(ctx context.Context, params *DescribeRoutingProfileInput, optFns ...func(*Options)) (*DescribeRoutingProfileOutput, error)

Describes the specified routing profile.

func (*Client) DescribeRule added in v1.39.0 

func (c *Client) DescribeRule(ctx context.Context, params *DescribeRuleInput, optFns ...func(*Options)) (*DescribeRuleOutput, error)

Describes a rule for the specified Amazon Connect instance.

func (*Client) DescribeSecurityProfile added in v1.11.0 

func (c *Client) DescribeSecurityProfile(ctx context.Context, params *DescribeSecurityProfileInput, optFns ...func(*Options)) (*DescribeSecurityProfileOutput, error)

Gets basic information about the security profle.

func (*Client) DescribeTrafficDistributionGroup added in v1.33.0 

func (c *Client) DescribeTrafficDistributionGroup(ctx context.Context, params *DescribeTrafficDistributionGroupInput, optFns ...func(*Options)) (*DescribeTrafficDistributionGroupOutput, error)

Gets details and status of a traffic distribution group.

func (*Client) DescribeUser 

func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)

Describes the specified user. You can find the instance ID in the Amazon Connect console (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

func (*Client) DescribeUserHierarchyGroup 

func (c *Client) DescribeUserHierarchyGroup(ctx context.Context, params *DescribeUserHierarchyGroupInput, optFns ...func(*Options)) (*DescribeUserHierarchyGroupOutput, error)

Describes the specified hierarchy group.

func (*Client) DescribeUserHierarchyStructure 

func (c *Client) DescribeUserHierarchyStructure(ctx context.Context, params *DescribeUserHierarchyStructureInput, optFns ...func(*Options)) (*DescribeUserHierarchyStructureOutput, error)

Describes the hierarchy structure of the specified Amazon Connect instance.

func (*Client) DescribeView added in v1.66.0 

func (c *Client) DescribeView(ctx context.Context, params *DescribeViewInput, optFns ...func(*Options)) (*DescribeViewOutput, error)

Retrieves the view for the specified Amazon Connect instance and view identifier. The view identifier can be supplied as a ViewId or ARN. $SAVED needs to be supplied if a view is unpublished. The view identifier can contain an optional qualifier, for example, :$SAVED , which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST . If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

func (*Client) DescribeVocabulary added in v1.17.0 

func (c *Client) DescribeVocabulary(ctx context.Context, params *DescribeVocabularyInput, optFns ...func(*Options)) (*DescribeVocabularyOutput, error)

Describes the specified vocabulary.

func (*Client) DisassociateAnalyticsDataSet added in v1.82.0 

func (c *Client) DisassociateAnalyticsDataSet(ctx context.Context, params *DisassociateAnalyticsDataSetInput, optFns ...func(*Options)) (*DisassociateAnalyticsDataSetOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Removes the dataset ID associated with a given Amazon Connect instance.

func (*Client) DisassociateApprovedOrigin added in v0.30.0 

func (c *Client) DisassociateApprovedOrigin(ctx context.Context, params *DisassociateApprovedOriginInput, optFns ...func(*Options)) (*DisassociateApprovedOriginOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect.

func (*Client) DisassociateBot added in v1.5.0 

func (c *Client) DisassociateBot(ctx context.Context, params *DisassociateBotInput, optFns ...func(*Options)) (*DisassociateBotOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

func (*Client) DisassociateFlow added in v1.82.0 

func (c *Client) DisassociateFlow(ctx context.Context, params *DisassociateFlowInput, optFns ...func(*Options)) (*DisassociateFlowOutput, error)

Disassociates a connect resource from a flow.

func (*Client) DisassociateInstanceStorageConfig added in v0.30.0 

func (c *Client) DisassociateInstanceStorageConfig(ctx context.Context, params *DisassociateInstanceStorageConfigInput, optFns ...func(*Options)) (*DisassociateInstanceStorageConfigOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Removes the storage type configurations for the specified resource type and association ID.

func (*Client) DisassociateLambdaFunction added in v0.30.0 

func (c *Client) DisassociateLambdaFunction(ctx context.Context, params *DisassociateLambdaFunctionInput, optFns ...func(*Options)) (*DisassociateLambdaFunctionOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Remove the Lambda function from the dropdown options available in the relevant flow blocks.

func (*Client) DisassociateLexBot added in v0.30.0 

func (c *Client) DisassociateLexBot(ctx context.Context, params *DisassociateLexBotInput, optFns ...func(*Options)) (*DisassociateLexBotOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot.

func (*Client) DisassociatePhoneNumberContactFlow added in v1.22.0 

func (c *Client) DisassociatePhoneNumberContactFlow(ctx context.Context, params *DisassociatePhoneNumberContactFlowInput, optFns ...func(*Options)) (*DisassociatePhoneNumberContactFlowOutput, error)

Removes the flow association from a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException .

func (*Client) DisassociateQueueQuickConnects added in v1.2.0 

func (c *Client) DisassociateQueueQuickConnects(ctx context.Context, params *DisassociateQueueQuickConnectsInput, optFns ...func(*Options)) (*DisassociateQueueQuickConnectsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Disassociates a set of quick connects from a queue.

func (*Client) DisassociateRoutingProfileQueues added in v0.29.0 

func (c *Client) DisassociateRoutingProfileQueues(ctx context.Context, params *DisassociateRoutingProfileQueuesInput, optFns ...func(*Options)) (*DisassociateRoutingProfileQueuesOutput, error)

Disassociates a set of queues from a routing profile.

func (*Client) DisassociateSecurityKey added in v0.30.0 

func (c *Client) DisassociateSecurityKey(ctx context.Context, params *DisassociateSecurityKeyInput, optFns ...func(*Options)) (*DisassociateSecurityKeyOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key.

func (*Client) DisassociateTrafficDistributionGroupUser added in v1.65.0 

func (c *Client) DisassociateTrafficDistributionGroupUser(ctx context.Context, params *DisassociateTrafficDistributionGroupUserInput, optFns ...func(*Options)) (*DisassociateTrafficDistributionGroupUserOutput, error)

Disassociates an agent from a traffic distribution group.

func (*Client) DisassociateUserProficiencies added in v1.87.0 

func (c *Client) DisassociateUserProficiencies(ctx context.Context, params *DisassociateUserProficienciesInput, optFns ...func(*Options)) (*DisassociateUserProficienciesOutput, error)

Disassociates a set of proficiencies from a user.

func (*Client) DismissUserContact added in v1.34.0 

func (c *Client) DismissUserContact(ctx context.Context, params *DismissUserContactInput, optFns ...func(*Options)) (*DismissUserContactOutput, error)

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED , ERROR , ENDED , or REJECTED state in the Agent Event Stream (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html) .

func (*Client) GetContactAttributes 

func (c *Client) GetContactAttributes(ctx context.Context, params *GetContactAttributesInput, optFns ...func(*Options)) (*GetContactAttributesOutput, error)

Retrieves the contact attributes for the specified contact.

func (*Client) GetCurrentMetricData 

func (c *Client) GetCurrentMetricData(ctx context.Context, params *GetCurrentMetricDataInput, optFns ...func(*Options)) (*GetCurrentMetricDataOutput, error)

Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Real-time Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) in the Amazon Connect Administrator Guide.

func (*Client) GetCurrentUserData added in v1.26.0 

func (c *Client) GetCurrentUserData(ctx context.Context, params *GetCurrentUserDataInput, optFns ...func(*Options)) (*GetCurrentUserDataOutput, error)

Gets the real-time active user data from the specified Amazon Connect instance.

func (*Client) GetFederationToken 

func (c *Client) GetFederationToken(ctx context.Context, params *GetFederationTokenInput, optFns ...func(*Options)) (*GetFederationTokenOutput, error)

Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. (https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html) This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

func (*Client) GetFlowAssociation added in v1.82.0 

func (c *Client) GetFlowAssociation(ctx context.Context, params *GetFlowAssociationInput, optFns ...func(*Options)) (*GetFlowAssociationOutput, error)

Retrieves the flow associated for a given resource.

func (*Client) GetMetricData 

func (c *Client) GetMetricData(ctx context.Context, params *GetMetricDataInput, optFns ...func(*Options)) (*GetMetricDataOutput, error)

Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Historical Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) in the Amazon Connect Administrator Guide. We recommend using the GetMetricDataV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData . Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

func (*Client) GetMetricDataV2 added in v1.49.0 

func (c *Client) GetMetricDataV2(ctx context.Context, params *GetMetricDataV2Input, optFns ...func(*Options)) (*GetMetricDataV2Output, error)

Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html) , the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData , see Historical metrics definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) in the Amazon Connect Administrator's Guide.

func (*Client) GetPromptFile added in v1.55.0 

func (c *Client) GetPromptFile(ctx context.Context, params *GetPromptFileInput, optFns ...func(*Options)) (*GetPromptFileOutput, error)

Gets the prompt file.

func (*Client) GetTaskTemplate added in v1.25.0 

func (c *Client) GetTaskTemplate(ctx context.Context, params *GetTaskTemplateInput, optFns ...func(*Options)) (*GetTaskTemplateOutput, error)

Gets details about a specific task template in the specified Amazon Connect instance.

func (*Client) GetTrafficDistribution added in v1.33.0 

func (c *Client) GetTrafficDistribution(ctx context.Context, params *GetTrafficDistributionInput, optFns ...func(*Options)) (*GetTrafficDistributionOutput, error)

Retrieves the current traffic distribution for a given traffic distribution group.

func (*Client) ImportPhoneNumber added in v1.82.0 

func (c *Client) ImportPhoneNumber(ctx context.Context, params *ImportPhoneNumberInput, optFns ...func(*Options)) (*ImportPhoneNumberOutput, error)

Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

func (*Client) ListAgentStatuses added in v1.6.0 

func (c *Client) ListAgentStatuses(ctx context.Context, params *ListAgentStatusesInput, optFns ...func(*Options)) (*ListAgentStatusesOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Lists agent statuses.

func (*Client) ListAnalyticsDataAssociations added in v1.82.0 

func (c *Client) ListAnalyticsDataAssociations(ctx context.Context, params *ListAnalyticsDataAssociationsInput, optFns ...func(*Options)) (*ListAnalyticsDataAssociationsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Lists the association status of requested dataset ID for a given Amazon Connect instance.

func (*Client) ListApprovedOrigins added in v0.30.0 

func (c *Client) ListApprovedOrigins(ctx context.Context, params *ListApprovedOriginsInput, optFns ...func(*Options)) (*ListApprovedOriginsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance.

func (*Client) ListBots added in v1.5.0 

func (c *Client) ListBots(ctx context.Context, params *ListBotsInput, optFns ...func(*Options)) (*ListBotsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.

func (*Client) ListContactEvaluations added in v1.53.0 

func (c *Client) ListContactEvaluations(ctx context.Context, params *ListContactEvaluationsInput, optFns ...func(*Options)) (*ListContactEvaluationsOutput, error)

Lists contact evaluations in the specified Amazon Connect instance.

func (*Client) ListContactFlowModules added in v1.13.0 

func (c *Client) ListContactFlowModules(ctx context.Context, params *ListContactFlowModulesInput, optFns ...func(*Options)) (*ListContactFlowModulesOutput, error)

Provides information about the flow modules for the specified Amazon Connect instance.

func (*Client) ListContactFlows 

func (c *Client) ListContactFlows(ctx context.Context, params *ListContactFlowsInput, optFns ...func(*Options)) (*ListContactFlowsOutput, error)

Provides information about the flows for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) . For more information about flows, see Flows (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html) in the Amazon Connect Administrator Guide.

func (*Client) ListContactReferences added in v1.12.0 

func (c *Client) ListContactReferences(ctx context.Context, params *ListContactReferencesInput, optFns ...func(*Options)) (*ListContactReferencesOutput, error)

This API is in preview release for Amazon Connect and is subject to change. For the specified referenceTypes , returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

func (*Client) ListDefaultVocabularies added in v1.17.0 

func (c *Client) ListDefaultVocabularies(ctx context.Context, params *ListDefaultVocabulariesInput, optFns ...func(*Options)) (*ListDefaultVocabulariesOutput, error)

Lists the default vocabularies for the specified Amazon Connect instance.

func (*Client) ListEvaluationFormVersions added in v1.53.0 

func (c *Client) ListEvaluationFormVersions(ctx context.Context, params *ListEvaluationFormVersionsInput, optFns ...func(*Options)) (*ListEvaluationFormVersionsOutput, error)

Lists versions of an evaluation form in the specified Amazon Connect instance.

func (*Client) ListEvaluationForms added in v1.53.0 

func (c *Client) ListEvaluationForms(ctx context.Context, params *ListEvaluationFormsInput, optFns ...func(*Options)) (*ListEvaluationFormsOutput, error)

Lists evaluation forms in the specified Amazon Connect instance.

func (*Client) ListFlowAssociations added in v1.82.0 

func (c *Client) ListFlowAssociations(ctx context.Context, params *ListFlowAssociationsInput, optFns ...func(*Options)) (*ListFlowAssociationsOutput, error)

List the flow association based on the filters.

func (*Client) ListHoursOfOperations 

func (c *Client) ListHoursOfOperations(ctx context.Context, params *ListHoursOfOperationsInput, optFns ...func(*Options)) (*ListHoursOfOperationsOutput, error)

Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue (https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html) in the Amazon Connect Administrator Guide.

func (*Client) ListInstanceAttributes added in v0.30.0 

func (c *Client) ListInstanceAttributes(ctx context.Context, params *ListInstanceAttributesInput, optFns ...func(*Options)) (*ListInstanceAttributesOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all attribute types for the given instance.

func (*Client) ListInstanceStorageConfigs added in v0.30.0 

func (c *Client) ListInstanceStorageConfigs(ctx context.Context, params *ListInstanceStorageConfigsInput, optFns ...func(*Options)) (*ListInstanceStorageConfigsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type.

func (*Client) ListInstances added in v0.30.0 

func (c *Client) ListInstances(ctx context.Context, params *ListInstancesInput, optFns ...func(*Options)) (*ListInstancesOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

func (*Client) ListIntegrationAssociations added in v0.31.0 

func (c *Client) ListIntegrationAssociations(ctx context.Context, params *ListIntegrationAssociationsInput, optFns ...func(*Options)) (*ListIntegrationAssociationsOutput, error)

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

func (*Client) ListLambdaFunctions added in v0.30.0 

func (c *Client) ListLambdaFunctions(ctx context.Context, params *ListLambdaFunctionsInput, optFns ...func(*Options)) (*ListLambdaFunctionsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

func (*Client) ListLexBots added in v0.30.0 

func (c *Client) ListLexBots(ctx context.Context, params *ListLexBotsInput, optFns ...func(*Options)) (*ListLexBotsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListBots.html) API.

func (*Client) ListPhoneNumbers 

func (c *Client) ListPhoneNumbers(ctx context.Context, params *ListPhoneNumbersInput, optFns ...func(*Options)) (*ListPhoneNumbersOutput, error)

Provides information about the phone numbers for the specified Amazon Connect instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center (https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) in the Amazon Connect Administrator Guide.

func (*Client) ListPhoneNumbersV2 added in v1.22.0 

func (c *Client) ListPhoneNumbersV2(ctx context.Context, params *ListPhoneNumbersV2Input, optFns ...func(*Options)) (*ListPhoneNumbersV2Output, error)

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center (https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) in the Amazon Connect Administrator Guide.

  • When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.
  • When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

func (*Client) ListPredefinedAttributes added in v1.87.0 

func (c *Client) ListPredefinedAttributes(ctx context.Context, params *ListPredefinedAttributesInput, optFns ...func(*Options)) (*ListPredefinedAttributesOutput, error)

Lists predefined attributes for the specified Amazon Connect instance.

func (*Client) ListPrompts added in v0.29.0 

func (c *Client) ListPrompts(ctx context.Context, params *ListPromptsInput, optFns ...func(*Options)) (*ListPromptsOutput, error)

Provides information about the prompts for the specified Amazon Connect instance.

func (*Client) ListQueueQuickConnects added in v1.2.0 

func (c *Client) ListQueueQuickConnects(ctx context.Context, params *ListQueueQuickConnectsInput, optFns ...func(*Options)) (*ListQueueQuickConnectsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Lists the quick connects associated with a queue.

func (*Client) ListQueues 

func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns ...func(*Options)) (*ListQueuesOutput, error)

Provides information about the queues for the specified Amazon Connect instance. If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. For more information about queues, see Queues: Standard and Agent (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html) in the Amazon Connect Administrator Guide.

func (*Client) ListQuickConnects added in v0.31.0 

func (c *Client) ListQuickConnects(ctx context.Context, params *ListQuickConnectsInput, optFns ...func(*Options)) (*ListQuickConnectsOutput, error)

Provides information about the quick connects for the specified Amazon Connect instance.

func (*Client) ListRealtimeContactAnalysisSegmentsV2 added in v1.82.0 

func (c *Client) ListRealtimeContactAnalysisSegmentsV2(ctx context.Context, params *ListRealtimeContactAnalysisSegmentsV2Input, optFns ...func(*Options)) (*ListRealtimeContactAnalysisSegmentsV2Output, error)

Provides a list of analysis segments for a real-time analysis session.

func (*Client) ListRoutingProfileQueues added in v0.29.0 

func (c *Client) ListRoutingProfileQueues(ctx context.Context, params *ListRoutingProfileQueuesInput, optFns ...func(*Options)) (*ListRoutingProfileQueuesOutput, error)

Lists the queues associated with a routing profile.

func (*Client) ListRoutingProfiles 

func (c *Client) ListRoutingProfiles(ctx context.Context, params *ListRoutingProfilesInput, optFns ...func(*Options)) (*ListRoutingProfilesOutput, error)

Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html) and Create a Routing Profile (https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html) in the Amazon Connect Administrator Guide.

func (*Client) ListRules added in v1.39.0 

func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns ...func(*Options)) (*ListRulesOutput, error)

List all rules for the specified Amazon Connect instance.

func (*Client) ListSecurityKeys added in v0.30.0 

func (c *Client) ListSecurityKeys(ctx context.Context, params *ListSecurityKeysInput, optFns ...func(*Options)) (*ListSecurityKeysOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all security keys associated with the instance.

func (*Client) ListSecurityProfileApplications added in v1.68.0 

func (c *Client) ListSecurityProfileApplications(ctx context.Context, params *ListSecurityProfileApplicationsInput, optFns ...func(*Options)) (*ListSecurityProfileApplicationsOutput, error)

Returns a list of third-party applications in a specific security profile.

func (*Client) ListSecurityProfilePermissions added in v1.11.0 

func (c *Client) ListSecurityProfilePermissions(ctx context.Context, params *ListSecurityProfilePermissionsInput, optFns ...func(*Options)) (*ListSecurityProfilePermissionsOutput, error)

Lists the permissions granted to a security profile.

func (*Client) ListSecurityProfiles 

func (c *Client) ListSecurityProfiles(ctx context.Context, params *ListSecurityProfilesInput, optFns ...func(*Options)) (*ListSecurityProfilesOutput, error)

Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles (https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the Amazon Connect Administrator Guide.

func (*Client) ListTagsForResource 

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

Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) in the Amazon Connect Administrator Guide.

func (*Client) ListTaskTemplates added in v1.25.0 

func (c *Client) ListTaskTemplates(ctx context.Context, params *ListTaskTemplatesInput, optFns ...func(*Options)) (*ListTaskTemplatesOutput, error)

Lists task templates for the specified Amazon Connect instance.

func (*Client) ListTrafficDistributionGroupUsers added in v1.65.0 

func (c *Client) ListTrafficDistributionGroupUsers(ctx context.Context, params *ListTrafficDistributionGroupUsersInput, optFns ...func(*Options)) (*ListTrafficDistributionGroupUsersOutput, error)

Lists traffic distribution group users.

func (*Client) ListTrafficDistributionGroups added in v1.33.0 

func (c *Client) ListTrafficDistributionGroups(ctx context.Context, params *ListTrafficDistributionGroupsInput, optFns ...func(*Options)) (*ListTrafficDistributionGroupsOutput, error)

Lists traffic distribution groups.

func (*Client) ListUseCases added in v0.31.0 

func (c *Client) ListUseCases(ctx context.Context, params *ListUseCasesInput, optFns ...func(*Options)) (*ListUseCasesOutput, error)

Lists the use cases for the integration association.

func (*Client) ListUserHierarchyGroups 

func (c *Client) ListUserHierarchyGroups(ctx context.Context, params *ListUserHierarchyGroupsInput, optFns ...func(*Options)) (*ListUserHierarchyGroupsOutput, error)

Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies (https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) in the Amazon Connect Administrator Guide.

func (*Client) ListUserProficiencies added in v1.87.0 

func (c *Client) ListUserProficiencies(ctx context.Context, params *ListUserProficienciesInput, optFns ...func(*Options)) (*ListUserProficienciesOutput, error)

Lists proficiencies associated with a user.

func (*Client) ListUsers 

func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)

Provides summary information about the users for the specified Amazon Connect instance.

func (*Client) ListViewVersions added in v1.66.0 

func (c *Client) ListViewVersions(ctx context.Context, params *ListViewVersionsInput, optFns ...func(*Options)) (*ListViewVersionsOutput, error)

Returns all the available versions for the specified Amazon Connect instance and view identifier. Results will be sorted from highest to lowest.

func (*Client) ListViews added in v1.66.0 

func (c *Client) ListViews(ctx context.Context, params *ListViewsInput, optFns ...func(*Options)) (*ListViewsOutput, error)

Returns views in the given instance. Results are sorted primarily by type, and secondarily by name.

func (*Client) MonitorContact added in v1.37.0 

func (c *Client) MonitorContact(ctx context.Context, params *MonitorContactInput, optFns ...func(*Options)) (*MonitorContactOutput, error)

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

func (*Client) Options added in v1.83.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) PauseContact added in v1.86.0 

func (c *Client) PauseContact(ctx context.Context, params *PauseContactInput, optFns ...func(*Options)) (*PauseContactOutput, error)

Allows pausing an ongoing task contact.

func (*Client) PutUserStatus added in v1.24.0 

func (c *Client) PutUserStatus(ctx context.Context, params *PutUserStatusInput, optFns ...func(*Options)) (*PutUserStatusOutput, error)

Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status. For more information, see Agent status (https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html) and Set your next status (https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html) in the Amazon Connect Administrator Guide.

func (*Client) ReleasePhoneNumber added in v1.22.0 

func (c *Client) ReleasePhoneNumber(ctx context.Context, params *ReleasePhoneNumberInput, optFns ...func(*Options)) (*ReleasePhoneNumberOutput, error)

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support. If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

func (*Client) ReplicateInstance added in v1.33.0 

func (c *Client) ReplicateInstance(ctx context.Context, params *ReplicateInstanceInput, optFns ...func(*Options)) (*ReplicateInstanceOutput, error)

Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions. For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance (https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html) in the Amazon Connect Administrator Guide.

func (*Client) ResumeContact added in v1.86.0 

func (c *Client) ResumeContact(ctx context.Context, params *ResumeContactInput, optFns ...func(*Options)) (*ResumeContactOutput, error)

Allows resuming a task contact in a paused state.

func (*Client) ResumeContactRecording 

func (c *Client) ResumeContactRecording(ctx context.Context, params *ResumeContactRecordingInput, optFns ...func(*Options)) (*ResumeContactRecordingOutput, error)

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume. Voice and screen recordings are supported.

func (*Client) SearchAvailablePhoneNumbers added in v1.22.0 

func (c *Client) SearchAvailablePhoneNumbers(ctx context.Context, params *SearchAvailablePhoneNumbersInput, optFns ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error)

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

func (*Client) SearchContacts added in v1.87.0 

func (c *Client) SearchContacts(ctx context.Context, params *SearchContactsInput, optFns ...func(*Options)) (*SearchContactsOutput, error)

Searches contacts in an Amazon Connect instance.

func (*Client) SearchHoursOfOperations added in v1.58.0 

func (c *Client) SearchHoursOfOperations(ctx context.Context, params *SearchHoursOfOperationsInput, optFns ...func(*Options)) (*SearchHoursOfOperationsOutput, error)

Searches the hours of operation in an Amazon Connect instance, with optional filtering.

func (*Client) SearchPredefinedAttributes added in v1.87.0 

func (c *Client) SearchPredefinedAttributes(ctx context.Context, params *SearchPredefinedAttributesInput, optFns ...func(*Options)) (*SearchPredefinedAttributesOutput, error)

Predefined attributes that meet certain criteria.

func (*Client) SearchPrompts added in v1.58.0 

func (c *Client) SearchPrompts(ctx context.Context, params *SearchPromptsInput, optFns ...func(*Options)) (*SearchPromptsOutput, error)

Searches prompts in an Amazon Connect instance, with optional filtering.

func (*Client) SearchQueues added in v1.29.0 

func (c *Client) SearchQueues(ctx context.Context, params *SearchQueuesInput, optFns ...func(*Options)) (*SearchQueuesOutput, error)

Searches queues in an Amazon Connect instance, with optional filtering.

func (*Client) SearchQuickConnects added in v1.58.0 

func (c *Client) SearchQuickConnects(ctx context.Context, params *SearchQuickConnectsInput, optFns ...func(*Options)) (*SearchQuickConnectsOutput, error)

Searches quick connects in an Amazon Connect instance, with optional filtering.

func (*Client) SearchResourceTags added in v1.60.0 

func (c *Client) SearchResourceTags(ctx context.Context, params *SearchResourceTagsInput, optFns ...func(*Options)) (*SearchResourceTagsOutput, error)

Searches tags used in an Amazon Connect instance using optional search criteria.

func (*Client) SearchRoutingProfiles added in v1.29.0 

func (c *Client) SearchRoutingProfiles(ctx context.Context, params *SearchRoutingProfilesInput, optFns ...func(*Options)) (*SearchRoutingProfilesOutput, error)

Searches routing profiles in an Amazon Connect instance, with optional filtering.

func (*Client) SearchSecurityProfiles added in v1.28.0 

func (c *Client) SearchSecurityProfiles(ctx context.Context, params *SearchSecurityProfilesInput, optFns ...func(*Options)) (*SearchSecurityProfilesOutput, error)

Searches security profiles in an Amazon Connect instance, with optional filtering.

func (*Client) SearchUsers added in v1.23.0 

func (c *Client) SearchUsers(ctx context.Context, params *SearchUsersInput, optFns ...func(*Options)) (*SearchUsersOutput, error)

Searches users in an Amazon Connect instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds.

func (*Client) SearchVocabularies added in v1.17.0 

func (c *Client) SearchVocabularies(ctx context.Context, params *SearchVocabulariesInput, optFns ...func(*Options)) (*SearchVocabulariesOutput, error)

Searches for vocabularies within a specific Amazon Connect instance using State , NameStartsWith , and LanguageCode .

func (*Client) SendChatIntegrationEvent added in v1.82.0 

func (c *Client) SendChatIntegrationEvent(ctx context.Context, params *SendChatIntegrationEventInput, optFns ...func(*Options)) (*SendChatIntegrationEventOutput, error)

Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

  • SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
  • ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action. Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.

func (*Client) StartChatContact 

func (c *Client) StartChatContact(ctx context.Context, params *StartChatContactInput, optFns ...func(*Options)) (*StartChatContactOutput, error)

Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following situations:

If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. For more information about chat, see Chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat.html) in the Amazon Connect Administrator Guide.

func (*Client) StartContactEvaluation added in v1.53.0 

func (c *Client) StartContactEvaluation(ctx context.Context, params *StartContactEvaluationInput, optFns ...func(*Options)) (*StartContactEvaluationOutput, error)

Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started. Evaluations created through the public API do not contain answer values suggested from automation.

func (*Client) StartContactRecording 

func (c *Client) StartContactRecording(ctx context.Context, params *StartContactRecordingInput, optFns ...func(*Options)) (*StartContactRecordingOutput, error)

Starts recording the contact:

  • If the API is called before the agent joins the call, recording starts when the agent joins the call.
  • If the API is called after the agent joins the call, recording starts at the time of the API call.

StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. You can use this API to override the recording behavior configured in the Set recording behavior (https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html) block. Only voice recordings are supported at this time.

func (*Client) StartContactStreaming added in v1.10.0 

func (c *Client) StartContactStreaming(ctx context.Context, params *StartContactStreamingInput, optFns ...func(*Options)) (*StartContactStreamingOutput, error)

Initiates real-time message streaming for a new chat contact. For more information about message streaming, see Enable real-time chat message streaming (https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html) in the Amazon Connect Administrator Guide.

func (*Client) StartOutboundVoiceContact 

func (c *Client) StartOutboundVoiceContact(ctx context.Context, params *StartOutboundVoiceContactInput, optFns ...func(*Options)) (*StartOutboundVoiceContactOutput, error)

Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId ). Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case. There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the Amazon Connect Administrator Guide. Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN , you must submit a service quota increase request to the quota Amazon Connect campaigns (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas) .

func (*Client) StartTaskContact added in v0.31.0 

func (c *Client) StartTaskContact(ctx context.Context, params *StartTaskContactInput, optFns ...func(*Options)) (*StartTaskContactOutput, error)

Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect (https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html) in the Amazon Connect Administrator Guide. When using PreviousContactId and RelatedContactId input parameters, note the following:

  • PreviousContactId
  • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.
  • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId .
  • RelatedContactId
  • Copies contact attributes from the related task contact to the new contact.
  • Any update on attributes in a new task contact does not update attributes on previous contact.
  • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId .

In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID , QuickConnectID , or TaskTemplateID . Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created. A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId . For more information about service quotas for task contacts, see Amazon Connect service quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the Amazon Connect Administrator Guide.

func (*Client) StartWebRTCContact added in v1.82.0 

func (c *Client) StartWebRTCContact(ctx context.Context, params *StartWebRTCContactInput, optFns ...func(*Options)) (*StartWebRTCContactOutput, error)

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

func (*Client) StopContact 

func (c *Client) StopContact(ctx context.Context, params *StopContactInput, optFns ...func(*Options)) (*StopContactOutput, error)

Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

  • DISCONNECT
  • TRANSFER
  • QUEUE_TRANSFER

Chat and task contacts can be terminated in any state, regardless of initiation method.

func (*Client) StopContactRecording 

func (c *Client) StopContactRecording(ctx context.Context, params *StopContactRecordingInput, optFns ...func(*Options)) (*StopContactRecordingOutput, error)

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording. Only voice recordings are supported at this time.

func (*Client) StopContactStreaming added in v1.10.0 

func (c *Client) StopContactStreaming(ctx context.Context, params *StopContactStreamingInput, optFns ...func(*Options)) (*StopContactStreamingOutput, error)

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html) API.

func (*Client) SubmitContactEvaluation added in v1.53.0 

func (c *Client) SubmitContactEvaluation(ctx context.Context, params *SubmitContactEvaluationInput, optFns ...func(*Options)) (*SubmitContactEvaluationOutput, error)

Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ( {} ) to the question identifier. If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

func (*Client) SuspendContactRecording 

func (c *Client) SuspendContactRecording(ctx context.Context, params *SuspendContactRecordingInput, optFns ...func(*Options)) (*SuspendContactRecordingOutput, error)

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen. The period of time that the recording is suspended is filled with silence in the final recording. Voice and screen recordings are supported.

func (*Client) TagContact added in v1.85.0 

func (c *Client) TagContact(ctx context.Context, params *TagContactInput, optFns ...func(*Options)) (*TagContactOutput, error)

Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage (https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html) .

func (*Client) TagResource 

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

Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect (https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html) . For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) in the Amazon Connect Administrator Guide.

func (*Client) TransferContact added in v1.25.0 

func (c *Client) TransferContact(ctx context.Context, params *TransferContactInput, optFns ...func(*Options)) (*TransferContactOutput, error)

Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers. Note the following requirements:

  • Transfer is supported for only TASK contacts.
  • Do not use both QueueId and UserId in the same call.
  • The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
  • The TransferContact API can be called only on active contacts.
  • A contact cannot be transferred more than 11 times.

func (*Client) UntagContact added in v1.85.0 

func (c *Client) UntagContact(ctx context.Context, params *UntagContactInput, optFns ...func(*Options)) (*UntagContactOutput, error)

Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage (https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html) .

func (*Client) UntagResource 

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

Removes the specified tags from the specified resource.

func (*Client) UpdateAgentStatus added in v1.6.0 

func (c *Client) UpdateAgentStatus(ctx context.Context, params *UpdateAgentStatusInput, optFns ...func(*Options)) (*UpdateAgentStatusOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates agent status.

func (*Client) UpdateContact added in v1.12.0 

func (c *Client) UpdateContact(ctx context.Context, params *UpdateContactInput, optFns ...func(*Options)) (*UpdateContactOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request. You can add or update user-defined contact information for both ongoing and completed contacts.

func (*Client) UpdateContactAttributes 

func (c *Client) UpdateContactAttributes(ctx context.Context, params *UpdateContactAttributesInput, optFns ...func(*Options)) (*UpdateContactAttributesOutput, error)

Creates or updates user-defined contact attributes associated with the specified contact. You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) in the Amazon Connect Administrator Guide.

func (*Client) UpdateContactEvaluation added in v1.53.0 

func (c *Client) UpdateContactEvaluation(ctx context.Context, params *UpdateContactEvaluationInput, optFns ...func(*Options)) (*UpdateContactEvaluationOutput, error)

Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ( {} ) to the question identifier.

func (*Client) UpdateContactFlowContent added in v0.29.0 

func (c *Client) UpdateContactFlowContent(ctx context.Context, params *UpdateContactFlowContentInput, optFns ...func(*Options)) (*UpdateContactFlowContentOutput, error)

Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) .

func (*Client) UpdateContactFlowMetadata added in v1.13.0 

func (c *Client) UpdateContactFlowMetadata(ctx context.Context, params *UpdateContactFlowMetadataInput, optFns ...func(*Options)) (*UpdateContactFlowMetadataOutput, error)

Updates metadata about specified flow.

func (*Client) UpdateContactFlowModuleContent added in v1.13.0 

func (c *Client) UpdateContactFlowModuleContent(ctx context.Context, params *UpdateContactFlowModuleContentInput, optFns ...func(*Options)) (*UpdateContactFlowModuleContentOutput, error)

Updates specified flow module for the specified Amazon Connect instance.

func (*Client) UpdateContactFlowModuleMetadata added in v1.13.0 

func (c *Client) UpdateContactFlowModuleMetadata(ctx context.Context, params *UpdateContactFlowModuleMetadataInput, optFns ...func(*Options)) (*UpdateContactFlowModuleMetadataOutput, error)

Updates metadata about specified flow module.

func (*Client) UpdateContactFlowName added in v0.29.0 

func (c *Client) UpdateContactFlowName(ctx context.Context, params *UpdateContactFlowNameInput, optFns ...func(*Options)) (*UpdateContactFlowNameOutput, error)

The name of the flow. You can also create and update flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) .

func (*Client) UpdateContactRoutingData added in v1.87.0 

func (c *Client) UpdateContactRoutingData(ctx context.Context, params *UpdateContactRoutingDataInput, optFns ...func(*Options)) (*UpdateContactRoutingDataOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block (https://docs.aws.amazon.com/connect/latest/adminguide/change-routing-priority.html) .

func (*Client) UpdateContactSchedule added in v1.12.0 

func (c *Client) UpdateContactSchedule(ctx context.Context, params *UpdateContactScheduleInput, optFns ...func(*Options)) (*UpdateContactScheduleOutput, error)

Updates the scheduled time of a task contact that is already scheduled.

func (*Client) UpdateEvaluationForm added in v1.53.0 

func (c *Client) UpdateEvaluationForm(ctx context.Context, params *UpdateEvaluationFormInput, optFns ...func(*Options)) (*UpdateEvaluationFormOutput, error)

Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form. This operation does not support partial updates. Instead it does a full update of evaluation form content.

func (*Client) UpdateHoursOfOperation added in v1.6.0 

func (c *Client) UpdateHoursOfOperation(ctx context.Context, params *UpdateHoursOfOperationInput, optFns ...func(*Options)) (*UpdateHoursOfOperationOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation.

func (*Client) UpdateInstanceAttribute added in v0.30.0 

func (c *Client) UpdateInstanceAttribute(ctx context.Context, params *UpdateInstanceAttributeInput, optFns ...func(*Options)) (*UpdateInstanceAttributeOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates the value for the specified attribute type.

func (*Client) UpdateInstanceStorageConfig added in v0.30.0 

func (c *Client) UpdateInstanceStorageConfig(ctx context.Context, params *UpdateInstanceStorageConfigInput, optFns ...func(*Options)) (*UpdateInstanceStorageConfigOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates an existing configuration for a resource type. This API is idempotent.

func (*Client) UpdateParticipantRoleConfig added in v1.41.0 

func (c *Client) UpdateParticipantRoleConfig(ctx context.Context, params *UpdateParticipantRoleConfigInput, optFns ...func(*Options)) (*UpdateParticipantRoleConfigOutput, error)

Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

  • Customer idle timeout
  • Customer auto-disconnect timeout
  • Agent idle timeout
  • Agent auto-disconnect timeout

For more information about how chat timeouts work, see Set up chat timeouts for human participants (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html) .

func (*Client) UpdatePhoneNumber added in v1.22.0 

func (c *Client) UpdatePhoneNumber(ctx context.Context, params *UpdatePhoneNumberInput, optFns ...func(*Options)) (*UpdatePhoneNumberOutput, error)

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region. After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too. You can call DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) API to verify the status of a previous UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) operation.

func (*Client) UpdatePhoneNumberMetadata added in v1.70.0 

func (c *Client) UpdatePhoneNumberMetadata(ctx context.Context, params *UpdatePhoneNumberMetadataInput, optFns ...func(*Options)) (*UpdatePhoneNumberMetadataOutput, error)

Updates a phone number’s metadata. To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) API.

func (*Client) UpdatePredefinedAttribute added in v1.87.0 

func (c *Client) UpdatePredefinedAttribute(ctx context.Context, params *UpdatePredefinedAttributeInput, optFns ...func(*Options)) (*UpdatePredefinedAttributeOutput, error)

Updates a predefined attribute for the specified Amazon Connect instance.

func (*Client) UpdatePrompt added in v1.55.0 

func (c *Client) UpdatePrompt(ctx context.Context, params *UpdatePromptInput, optFns ...func(*Options)) (*UpdatePromptOutput, error)

Updates a prompt.

func (*Client) UpdateQueueHoursOfOperation added in v1.2.0 

func (c *Client) UpdateQueueHoursOfOperation(ctx context.Context, params *UpdateQueueHoursOfOperationInput, optFns ...func(*Options)) (*UpdateQueueHoursOfOperationOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation for the specified queue.

func (*Client) UpdateQueueMaxContacts added in v1.2.0 

func (c *Client) UpdateQueueMaxContacts(ctx context.Context, params *UpdateQueueMaxContactsInput, optFns ...func(*Options)) (*UpdateQueueMaxContactsOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates the maximum number of contacts allowed in a queue before it is considered full.

func (*Client) UpdateQueueName added in v1.2.0 

func (c *Client) UpdateQueueName(ctx context.Context, params *UpdateQueueNameInput, optFns ...func(*Options)) (*UpdateQueueNameOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates the name and description of a queue. At least Name or Description must be provided.

func (*Client) UpdateQueueOutboundCallerConfig added in v1.2.0 

func (c *Client) UpdateQueueOutboundCallerConfig(ctx context.Context, params *UpdateQueueOutboundCallerConfigInput, optFns ...func(*Options)) (*UpdateQueueOutboundCallerConfigOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

  • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId . However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException .
  • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you call the ListPhoneNumbersV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) API.
  • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region) .

func (*Client) UpdateQueueStatus added in v1.2.0 

func (c *Client) UpdateQueueStatus(ctx context.Context, params *UpdateQueueStatusInput, optFns ...func(*Options)) (*UpdateQueueStatusOutput, error)

This API is in preview release for Amazon Connect and is subject to change. Updates the status of the queue.

func (*Client) UpdateQuickConnectConfig added in v0.31.0 

func (c *Client) UpdateQuickConnectConfig(ctx context.Context, params *UpdateQuickConnectConfigInput, optFns ...func(*Options)) (*UpdateQuickConnectConfigOutput, error)

Updates the configuration settings for the specified quick connect.

func (*Client) UpdateQuickConnectName added in v0.31.0 

func (c *Client) UpdateQuickConnectName(ctx context.Context, params *UpdateQuickConnectNameInput, optFns ...func(*Options)) (*UpdateQuickConnectNameOutput, error)

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

func (*Client) UpdateRoutingProfileAgentAvailabilityTimer added in v1.64.0 

func (c *Client) UpdateRoutingProfileAgentAvailabilityTimer(ctx context.Context, params *UpdateRoutingProfileAgentAvailabilityTimerInput, optFns ...func(*Options)) (*UpdateRoutingProfileAgentAvailabilityTimerOutput, error)

Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

func (*Client) UpdateRoutingProfileConcurrency added in v0.29.0 

func (c *Client) UpdateRoutingProfileConcurrency(ctx context.Context, params *UpdateRoutingProfileConcurrencyInput, optFns ...func(*Options)) (*UpdateRoutingProfileConcurrencyOutput, error)

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

func (*Client) UpdateRoutingProfileDefaultOutboundQueue added in v0.29.0 

func (c *Client) UpdateRoutingProfileDefaultOutboundQueue(ctx context.Context, params *UpdateRoutingProfileDefaultOutboundQueueInput, optFns ...func(*Options)) (*UpdateRoutingProfileDefaultOutboundQueueOutput, error)

Updates the default outbound queue of a routing profile.

func (*Client) UpdateRoutingProfileName added in v0.29.0 

func (c *Client) UpdateRoutingProfileName(ctx context.Context, params *UpdateRoutingProfileNameInput, optFns ...func(*Options)) (*UpdateRoutingProfileNameOutput, error)

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

func (*Client) UpdateRoutingProfileQueues added in v0.29.0 

func (c *Client) UpdateRoutingProfileQueues(ctx context.Context, params *UpdateRoutingProfileQueuesInput, optFns ...func(*Options)) (*UpdateRoutingProfileQueuesOutput, error)

Updates the properties associated with a set of queues for a routing profile.

func (*Client) UpdateRule added in v1.39.0 

func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns ...func(*Options)) (*UpdateRuleOutput, error)

Updates a rule for the specified Amazon Connect instance. Use the Rules Function language (https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html) to code conditions for the rule.

func (*Client) UpdateSecurityProfile added in v1.11.0 

func (c *Client) UpdateSecurityProfile(ctx context.Context, params *UpdateSecurityProfileInput, optFns ...func(*Options)) (*UpdateSecurityProfileOutput, error)

Updates a security profile.

func (*Client) UpdateTaskTemplate added in v1.25.0 

func (c *Client) UpdateTaskTemplate(ctx context.Context, params *UpdateTaskTemplateInput, optFns ...func(*Options)) (*UpdateTaskTemplateOutput, error)

Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

func (*Client) UpdateTrafficDistribution added in v1.33.0 

func (c *Client) UpdateTrafficDistribution(ctx context.Context, params *UpdateTrafficDistributionInput, optFns ...func(*Options)) (*UpdateTrafficDistributionOutput, error)

Updates the traffic distribution for a given traffic distribution group. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html) data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup , an InvalidRequestException is returned. For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions (https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html) in the Amazon Connect Administrator Guide.

func (*Client) UpdateUserHierarchy 

func (c *Client) UpdateUserHierarchy(ctx context.Context, params *UpdateUserHierarchyInput, optFns ...func(*Options)) (*UpdateUserHierarchyOutput, error)

Assigns the specified hierarchy group to the specified user.

func (*Client) UpdateUserHierarchyGroupName added in v0.30.0 

func (c *Client) UpdateUserHierarchyGroupName(ctx context.Context, params *UpdateUserHierarchyGroupNameInput, optFns ...func(*Options)) (*UpdateUserHierarchyGroupNameOutput, error)

Updates the name of the user hierarchy group.

func (*Client) UpdateUserHierarchyStructure added in v0.30.0 

func (c *Client) UpdateUserHierarchyStructure(ctx context.Context, params *UpdateUserHierarchyStructureInput, optFns ...func(*Options)) (*UpdateUserHierarchyStructureOutput, error)

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

func (*Client) UpdateUserIdentityInfo 

func (c *Client) UpdateUserIdentityInfo(ctx context.Context, params *UpdateUserIdentityInfoInput, optFns ...func(*Options)) (*UpdateUserIdentityInfoOutput, error)

Updates the identity information for the specified user. We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo . Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html) in the Amazon Connect Administrator Guide.

func (*Client) UpdateUserPhoneConfig 

func (c *Client) UpdateUserPhoneConfig(ctx context.Context, params *UpdateUserPhoneConfigInput, optFns ...func(*Options)) (*UpdateUserPhoneConfigOutput, error)

Updates the phone configuration settings for the specified user.

func (*Client) UpdateUserProficiencies added in v1.87.0 

func (c *Client) UpdateUserProficiencies(ctx context.Context, params *UpdateUserProficienciesInput, optFns ...func(*Options)) (*UpdateUserProficienciesOutput, error)

Updates the properties associated with the proficiencies of a user.

func (*Client) UpdateUserRoutingProfile 

func (c *Client) UpdateUserRoutingProfile(ctx context.Context, params *UpdateUserRoutingProfileInput, optFns ...func(*Options)) (*UpdateUserRoutingProfileOutput, error)

Assigns the specified routing profile to the specified user.

func (*Client) UpdateUserSecurityProfiles 

func (c *Client) UpdateUserSecurityProfiles(ctx context.Context, params *UpdateUserSecurityProfilesInput, optFns ...func(*Options)) (*UpdateUserSecurityProfilesOutput, error)

Assigns the specified security profiles to the specified user.

func (*Client) UpdateViewContent added in v1.66.0 

func (c *Client) UpdateViewContent(ctx context.Context, params *UpdateViewContentInput, optFns ...func(*Options)) (*UpdateViewContentOutput, error)

Updates the view content of the given view identifier in the specified Amazon Connect instance. It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED . Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED .

func (*Client) UpdateViewMetadata added in v1.66.0 

func (c *Client) UpdateViewMetadata(ctx context.Context, params *UpdateViewMetadataInput, optFns ...func(*Options)) (*UpdateViewMetadataOutput, error)

Updates the view metadata. Note that either Name or Description must be provided.

type CreateAgentStatusInput added in v1.6.0 

type CreateAgentStatusInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the status.
	//
	// This member is required.
	Name *string

	// The state of the status.
	//
	// This member is required.
	State types.AgentStatusState

	// The description of the status.
	Description *string

	// The display order of the status.
	DisplayOrder *int32

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAgentStatusOutput added in v1.6.0 

type CreateAgentStatusOutput struct {

	// The Amazon Resource Name (ARN) of the agent status.
	AgentStatusARN *string

	// The identifier of the agent status.
	AgentStatusId *string

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

type CreateContactFlowInput added in v0.29.0 

type CreateContactFlowInput struct {

	// The JSON string that represents the content of the flow. For an example, see
	// Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html)
	// . Length Constraints: Minimum length of 1. Maximum length of 256000.
	//
	// This member is required.
	Content *string

	// The identifier of the Amazon Connect instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the flow.
	//
	// This member is required.
	Name *string

	// The type of the flow. For descriptions of the available types, see Choose a
	// flow type (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types)
	// in the Amazon Connect Administrator Guide.
	//
	// This member is required.
	Type types.ContactFlowType

	// The description of the flow.
	Description *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateContactFlowModuleInput added in v1.13.0 

type CreateContactFlowModuleInput struct {

	// The JSON string that represents the content of the flow. For an example, see
	// Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html)
	// .
	//
	// This member is required.
	Content *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the flow module.
	//
	// This member is required.
	Name *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// The description of the flow module.
	Description *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateContactFlowModuleOutput added in v1.13.0 

type CreateContactFlowModuleOutput struct {

	// The Amazon Resource Name (ARN) of the flow module.
	Arn *string

	// The identifier of the flow module.
	Id *string

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

type CreateContactFlowOutput added in v0.29.0 

type CreateContactFlowOutput struct {

	// The Amazon Resource Name (ARN) of the flow.
	ContactFlowArn *string

	// The identifier of the flow.
	ContactFlowId *string

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

type CreateEvaluationFormInput added in v1.53.0 

type CreateEvaluationFormInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Items that are part of the evaluation form. The total number of sections and
	// questions must not exceed 100 each. Questions must be contained in a section.
	//
	// This member is required.
	Items []types.EvaluationFormItem

	// A title of the evaluation form.
	//
	// This member is required.
	Title *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// The description of the evaluation form.
	Description *string

	// A scoring strategy of the evaluation form.
	ScoringStrategy *types.EvaluationFormScoringStrategy
	// contains filtered or unexported fields
}

type CreateEvaluationFormOutput added in v1.53.0 

type CreateEvaluationFormOutput struct {

	// The Amazon Resource Name (ARN) for the evaluation form resource.
	//
	// This member is required.
	EvaluationFormArn *string

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

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

type CreateHoursOfOperationInput added in v1.6.0 

type CreateHoursOfOperationInput struct {

	// Configuration information for the hours of operation: day, start time, and end
	// time.
	//
	// This member is required.
	Config []types.HoursOfOperationConfig

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the hours of operation.
	//
	// This member is required.
	Name *string

	// The time zone of the hours of operation.
	//
	// This member is required.
	TimeZone *string

	// The description of the hours of operation.
	Description *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateHoursOfOperationOutput added in v1.6.0 

type CreateHoursOfOperationOutput struct {

	// The Amazon Resource Name (ARN) for the hours of operation.
	HoursOfOperationArn *string

	// The identifier for the hours of operation.
	HoursOfOperationId *string

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

type CreateInstanceInput added in v0.30.0 

type CreateInstanceInput struct {

	// The type of identity management for your Amazon Connect users.
	//
	// This member is required.
	IdentityManagementType types.DirectoryType

	// Your contact center handles incoming contacts.
	//
	// This member is required.
	InboundCallsEnabled *bool

	// Your contact center allows outbound calls.
	//
	// This member is required.
	OutboundCallsEnabled *bool

	// The idempotency token.
	ClientToken *string

	// The identifier for the directory.
	DirectoryId *string

	// The name for your instance.
	InstanceAlias *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} } .
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateInstanceOutput added in v0.30.0 

type CreateInstanceOutput struct {

	// The Amazon Resource Name (ARN) of the instance.
	Arn *string

	// The identifier for the instance.
	Id *string

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

type CreateIntegrationAssociationInput added in v0.31.0 

type CreateIntegrationAssociationInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The Amazon Resource Name (ARN) of the integration. When integrating with Amazon
	// Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same
	// account.
	//
	// This member is required.
	IntegrationArn *string

	// The type of information to be ingested.
	//
	// This member is required.
	IntegrationType types.IntegrationType

	// The name of the external application. This field is only required for the EVENT
	// integration type.
	SourceApplicationName *string

	// The URL for the external application. This field is only required for the EVENT
	// integration type.
	SourceApplicationUrl *string

	// The type of the data source. This field is only required for the EVENT
	// integration type.
	SourceType types.SourceType

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateIntegrationAssociationOutput added in v0.31.0 

type CreateIntegrationAssociationOutput struct {

	// The Amazon Resource Name (ARN) for the association.
	IntegrationAssociationArn *string

	// The identifier for the integration association.
	IntegrationAssociationId *string

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

type CreateParticipantInput added in v1.52.0 

type CreateParticipantInput struct {

	// The identifier of the contact in this instance of Amazon Connect. Only contacts
	// in the CHAT channel are supported.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Information identifying the participant. The only Valid value for
	// ParticipantRole is CUSTOM_BOT . DisplayName is Required.
	//
	// This member is required.
	ParticipantDetails *types.ParticipantDetailsToAdd

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateParticipantOutput added in v1.52.0 

type CreateParticipantOutput struct {

	// The token used by the chat participant to call CreateParticipantConnection . The
	// participant token is valid for the lifetime of a chat participant.
	ParticipantCredentials *types.ParticipantTokenCredentials

	// The identifier for a chat participant. The participantId for a chat participant
	// is the same throughout the chat lifecycle.
	ParticipantId *string

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

type CreatePersistentContactAssociationInput added in v1.76.0 

type CreatePersistentContactAssociationInput struct {

	// This is the contactId of the current contact that the
	// CreatePersistentContactAssociation API is being called from.
	//
	// This member is required.
	InitialContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The contactId chosen for rehydration depends on the type chosen.
	//   - ENTIRE_PAST_SESSION : Rehydrates a chat from the most recently terminated
	//   past chat contact of the specified past ended chat session. To use this type,
	//   provide the initialContactId of the past ended chat session in the
	//   sourceContactId field. In this type, Amazon Connect determines what the most
	//   recent chat contact on the past ended chat session and uses it to start a
	//   persistent chat.
	//   - FROM_SEGMENT : Rehydrates a chat from the specified past chat contact
	//   provided in the sourceContactId field.
	// The actual contactId used for rehydration is provided in the response of this
	// API. To illustrate how to use rehydration type, consider the following example:
	// A customer starts a chat session. Agent a1 accepts the chat and a conversation
	// starts between the customer and Agent a1. This first contact creates a contact
	// ID C1. Agent a1 then transfers the chat to Agent a2. This creates another
	// contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded
	// to the disconnect flow for a post chat survey that creates another contact ID
	// C3. After the chat survey, the chat session ends. Later, the customer returns
	// and wants to resume their past chat session. At this point, the customer can
	// have following use cases:
	//   - Use Case 1: The customer wants to continue the past chat session but they
	//   want to hide the post chat survey. For this they will use the following
	//   configuration:
	//   - Configuration
	//   - SourceContactId = "C2"
	//   - RehydrationType = "FROM_SEGMENT"
	//   - Expected behavior
	//   - This starts a persistent chat session from the specified past ended contact
	//   (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current
	//   persistent chat session. Note that chat segment C3 is dropped from the
	//   persistent chat session.
	//   - Use Case 2: The customer wants to continue the past chat session and see
	//   the transcript of the entire past engagement, including the post chat survey.
	//   For this they will use the following configuration:
	//   - Configuration
	//   - SourceContactId = "C1"
	//   - RehydrationType = "ENTIRE_PAST_SESSION"
	//   - Expected behavior
	//   - This starts a persistent chat session from the most recently ended chat
	//   contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in
	//   the current persistent chat session.
	//
	// This member is required.
	RehydrationType types.RehydrationType

	// The contactId from which a persistent chat session must be started.
	//
	// This member is required.
	SourceContactId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type CreatePersistentContactAssociationOutput added in v1.76.0 

type CreatePersistentContactAssociationOutput struct {

	// The contactId from which a persistent chat session is started. This field is
	// populated only for persistent chat.
	ContinuedFromContactId *string

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

type CreatePredefinedAttributeInput added in v1.87.0 

type CreatePredefinedAttributeInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the predefined attribute.
	//
	// This member is required.
	Name *string

	// The values of the predefined attribute.
	//
	// This member is required.
	Values types.PredefinedAttributeValues
	// contains filtered or unexported fields
}

type CreatePredefinedAttributeOutput added in v1.87.0 

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

type CreatePromptInput added in v1.55.0 

type CreatePromptInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the prompt.
	//
	// This member is required.
	Name *string

	// The URI for the S3 bucket where the prompt is stored. You can provide S3
	// pre-signed URLs returned by the GetPromptFile (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html)
	// API instead of providing S3 URIs.
	//
	// This member is required.
	S3Uri *string

	// The description of the prompt.
	Description *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreatePromptOutput added in v1.55.0 

type CreatePromptOutput struct {

	// The Amazon Resource Name (ARN) of the prompt.
	PromptARN *string

	// A unique identifier for the prompt.
	PromptId *string

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

type CreateQueueInput added in v1.2.0 

type CreateQueueInput struct {

	// The identifier for the hours of operation.
	//
	// This member is required.
	HoursOfOperationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the queue.
	//
	// This member is required.
	Name *string

	// The description of the queue.
	Description *string

	// The maximum number of contacts that can be in the queue before it is considered
	// full.
	MaxContacts *int32

	// The outbound caller ID name, number, and outbound whisper flow.
	OutboundCallerConfig *types.OutboundCallerConfig

	// The quick connects available to agents who are working the queue.
	QuickConnectIds []string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateQueueOutput added in v1.2.0 

type CreateQueueOutput struct {

	// The Amazon Resource Name (ARN) of the queue.
	QueueArn *string

	// The identifier for the queue.
	QueueId *string

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

type CreateQuickConnectInput added in v0.31.0 

type CreateQuickConnectInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique name of the quick connect.
	//
	// This member is required.
	Name *string

	// Configuration settings for the quick connect.
	//
	// This member is required.
	QuickConnectConfig *types.QuickConnectConfig

	// The description of the quick connect.
	Description *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateQuickConnectOutput added in v0.31.0 

type CreateQuickConnectOutput struct {

	// The Amazon Resource Name (ARN) for the quick connect.
	QuickConnectARN *string

	// The identifier for the quick connect.
	QuickConnectId *string

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

type CreateRoutingProfileInput added in v0.29.0 

type CreateRoutingProfileInput struct {

	// The default outbound queue for the routing profile.
	//
	// This member is required.
	DefaultOutboundQueueId *string

	// Description of the routing profile. Must not be more than 250 characters.
	//
	// This member is required.
	Description *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The channels that agents can handle in the Contact Control Panel (CCP) for this
	// routing profile.
	//
	// This member is required.
	MediaConcurrencies []types.MediaConcurrency

	// The name of the routing profile. Must not be more than 127 characters.
	//
	// This member is required.
	Name *string

	// Whether agents with this routing profile will have their routing order
	// calculated based on longest idle time or time since their last inbound contact.
	AgentAvailabilityTimer types.AgentAvailabilityTimer

	// The inbound queues associated with the routing profile. If no queue is added,
	// the agent can make only outbound calls. The limit of 10 array members applies to
	// the maximum number of RoutingProfileQueueConfig objects that can be passed
	// during a CreateRoutingProfile API request. It is different from the quota of 50
	// queues per routing profile per instance that is listed in Amazon Connect
	// service quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html)
	// .
	QueueConfigs []types.RoutingProfileQueueConfig

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateRoutingProfileOutput added in v0.29.0 

type CreateRoutingProfileOutput struct {

	// The Amazon Resource Name (ARN) of the routing profile.
	RoutingProfileArn *string

	// The identifier of the routing profile.
	RoutingProfileId *string

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

type CreateRuleInput added in v1.39.0 

type CreateRuleInput struct {

	// A list of actions to be run when the rule is triggered.
	//
	// This member is required.
	Actions []types.RuleAction

	// The conditions of the rule.
	//
	// This member is required.
	Function *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique name for the rule.
	//
	// This member is required.
	Name *string

	// The publish status of the rule.
	//
	// This member is required.
	PublishStatus types.RulePublishStatus

	// The event source to trigger the rule.
	//
	// This member is required.
	TriggerEventSource *types.RuleTriggerEventSource

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateRuleOutput added in v1.39.0 

type CreateRuleOutput struct {

	// The Amazon Resource Name (ARN) of the rule.
	//
	// This member is required.
	RuleArn *string

	// A unique identifier for the rule.
	//
	// This member is required.
	RuleId *string

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

type CreateSecurityProfileInput added in v1.11.0 

type CreateSecurityProfileInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the security profile.
	//
	// This member is required.
	SecurityProfileName *string

	// The identifier of the hierarchy group that a security profile uses to restrict
	// access to resources in Amazon Connect.
	AllowedAccessControlHierarchyGroupId *string

	// The list of tags that a security profile uses to restrict access to resources
	// in Amazon Connect.
	AllowedAccessControlTags map[string]string

	// A list of third-party applications that the security profile will give access
	// to.
	Applications []types.Application

	// The description of the security profile.
	Description *string

	// The list of resources that a security profile applies hierarchy restrictions to
	// in Amazon Connect. Following are acceptable ResourceNames: User .
	HierarchyRestrictedResources []string

	// Permissions assigned to the security profile. For a list of valid permissions,
	// see List of security profile permissions (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html)
	// .
	Permissions []string

	// The list of resources that a security profile applies tag restrictions to in
	// Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile
	// | Queue | RoutingProfile
	TagRestrictedResources []string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateSecurityProfileOutput added in v1.11.0 

type CreateSecurityProfileOutput struct {

	// The Amazon Resource Name (ARN) for the security profile.
	SecurityProfileArn *string

	// The identifier for the security profle.
	SecurityProfileId *string

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

type CreateTaskTemplateInput added in v1.25.0 

type CreateTaskTemplateInput struct {

	// Fields that are part of the template.
	//
	// This member is required.
	Fields []types.TaskTemplateField

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the task template.
	//
	// This member is required.
	Name *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// Constraints that are applicable to the fields listed.
	Constraints *types.TaskTemplateConstraints

	// The identifier of the flow that runs by default when a task is created by
	// referencing this template.
	ContactFlowId *string

	// The default values for fields when a task is created by referencing this
	// template.
	Defaults *types.TaskTemplateDefaults

	// The description of the task template.
	Description *string

	// Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
	// only be created from ACTIVE templates. If a template is marked as INACTIVE ,
	// then a task that refers to this template cannot be created.
	Status types.TaskTemplateStatus
	// contains filtered or unexported fields
}

type CreateTaskTemplateOutput added in v1.25.0 

type CreateTaskTemplateOutput struct {

	// The Amazon Resource Name (ARN) for the task template resource.
	//
	// This member is required.
	Arn *string

	// The identifier of the task template resource.
	//
	// This member is required.
	Id *string

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

type CreateTrafficDistributionGroupInput added in v1.33.0 

type CreateTrafficDistributionGroupInput struct {

	// The identifier of the Amazon Connect instance that has been replicated. You can
	// find the instanceId in the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name for the traffic distribution group.
	//
	// This member is required.
	Name *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// A description for the traffic distribution group.
	Description *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateTrafficDistributionGroupOutput added in v1.33.0 

type CreateTrafficDistributionGroupOutput struct {

	// The Amazon Resource Name (ARN) of the traffic distribution group.
	Arn *string

	// The identifier of the traffic distribution group. This can be the ID or the ARN
	// if the API is being called in the Region where the traffic distribution group
	// was created. The ARN must be provided if the call is from the replicated Region.
	Id *string

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

type CreateUseCaseInput added in v0.31.0 

type CreateUseCaseInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the integration association.
	//
	// This member is required.
	IntegrationAssociationId *string

	// The type of use case to associate to the integration association. Each
	// integration association can have only one of each use case type.
	//
	// This member is required.
	UseCaseType types.UseCaseType

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateUseCaseOutput added in v0.31.0 

type CreateUseCaseOutput struct {

	// The Amazon Resource Name (ARN) for the use case.
	UseCaseArn *string

	// The identifier of the use case.
	UseCaseId *string

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

type CreateUserHierarchyGroupInput added in v0.30.0 

type CreateUserHierarchyGroupInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the user hierarchy group. Must not be more than 100 characters.
	//
	// This member is required.
	Name *string

	// The identifier for the parent hierarchy group. The user hierarchy is created at
	// level one if the parent group ID is null.
	ParentGroupId *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateUserHierarchyGroupOutput added in v0.30.0 

type CreateUserHierarchyGroupOutput struct {

	// The Amazon Resource Name (ARN) of the hierarchy group.
	HierarchyGroupArn *string

	// The identifier of the hierarchy group.
	HierarchyGroupId *string

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

type CreateUserInput 

type CreateUserInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The phone settings for the user.
	//
	// This member is required.
	PhoneConfig *types.UserPhoneConfig

	// The identifier of the routing profile for the user.
	//
	// This member is required.
	RoutingProfileId *string

	// The identifier of the security profile for the user.
	//
	// This member is required.
	SecurityProfileIds []string

	// The user name for the account. For instances not using SAML for identity
	// management, the user name can include up to 20 characters. If you are using SAML
	// for identity management, the user name can include up to 64 characters from
	// [a-zA-Z0-9_-.\@]+. Username can include @ only if used in an email format. For
	// example:
	//   - Correct: testuser
	//   - Correct: testuser@example.com
	//   - Incorrect: testuser@example
	//
	// This member is required.
	Username *string

	// The identifier of the user account in the directory used for identity
	// management. If Amazon Connect cannot access the directory, you can specify this
	// identifier to authenticate users. If you include the identifier, we assume that
	// Amazon Connect cannot access the directory. Otherwise, the identity information
	// is used to authenticate users from your directory. This parameter is required if
	// you are using an existing directory for identity management in Amazon Connect
	// when Amazon Connect cannot access your directory to authenticate users. If you
	// are using SAML for identity management and include this parameter, an error is
	// returned.
	DirectoryUserId *string

	// The identifier of the hierarchy group for the user.
	HierarchyGroupId *string

	// The information about the identity of the user.
	IdentityInfo *types.UserIdentityInfo

	// The password for the user account. A password is required if you are using
	// Amazon Connect for identity management. Otherwise, it is an error to include a
	// password.
	Password *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateUserOutput 

type CreateUserOutput struct {

	// The Amazon Resource Name (ARN) of the user account.
	UserArn *string

	// The identifier of the user account.
	UserId *string

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

type CreateViewInput added in v1.66.0 

type CreateViewInput struct {

	// View content containing all content necessary to render a view except for
	// runtime input data. The total uncompressed content has a maximum file size of
	// 400kB.
	//
	// This member is required.
	Content *types.ViewInputContent

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the view.
	//
	// This member is required.
	Name *string

	// Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status
	// will initiate validation on the content.
	//
	// This member is required.
	Status types.ViewStatus

	// A unique Id for each create view request to avoid duplicate view creation. For
	// example, the view is idempotent ClientToken is provided.
	ClientToken *string

	// The description of the view.
	Description *string

	// The tags associated with the view resource (not specific to view version).These
	// tags can be used to organize, track, or control access for this resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateViewOutput added in v1.66.0 

type CreateViewOutput struct {

	// A view resource object. Contains metadata and content necessary to render the
	// view.
	View *types.View

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

type CreateViewVersionInput added in v1.66.0 

type CreateViewVersionInput struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the view. Both ViewArn and ViewId can be used.
	//
	// This member is required.
	ViewId *string

	// The description for the version being published.
	VersionDescription *string

	// Indicates the checksum value of the latest published view content.
	ViewContentSha256 *string
	// contains filtered or unexported fields
}

type CreateViewVersionOutput added in v1.66.0 

type CreateViewVersionOutput struct {

	// All view data is contained within the View object.
	View *types.View

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

type CreateVocabularyInput added in v1.17.0 

type CreateVocabularyInput struct {

	// The content of the custom vocabulary in plain-text format with a table of
	// values. Each row in the table represents a word or a phrase, described with
	// Phrase , IPA , SoundsLike , and DisplayAs fields. Separate the fields with TAB
	// characters. The size limit is 50KB. For more information, see Create a custom
	// vocabulary using a table (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table)
	// .
	//
	// This member is required.
	Content *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The language code of the vocabulary entries. For a list of languages and their
	// corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)
	//
	// This member is required.
	LanguageCode types.VocabularyLanguageCode

	// A unique name of the custom vocabulary.
	//
	// This member is required.
	VocabularyName *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// . If a create request is received more than once with same client token,
	// subsequent requests return the previous response without creating a vocabulary
	// again.
	ClientToken *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateVocabularyOutput added in v1.17.0 

type CreateVocabularyOutput struct {

	// The current state of the custom vocabulary.
	//
	// This member is required.
	State types.VocabularyState

	// The Amazon Resource Name (ARN) of the custom vocabulary.
	//
	// This member is required.
	VocabularyArn *string

	// The identifier of the custom vocabulary.
	//
	// This member is required.
	VocabularyId *string

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

type DeactivateEvaluationFormInput added in v1.53.0 

type DeactivateEvaluationFormInput struct {

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

	// A version of the evaluation form. If the version property is not provided, the
	// latest version of the evaluation form is deactivated.
	//
	// This member is required.
	EvaluationFormVersion int32

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DeactivateEvaluationFormOutput added in v1.53.0 

type DeactivateEvaluationFormOutput struct {

	// The Amazon Resource Name (ARN) for the evaluation form resource.
	//
	// This member is required.
	EvaluationFormArn *string

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

	// The version of the deactivated evaluation form resource.
	//
	// This member is required.
	EvaluationFormVersion int32

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

type DeleteContactEvaluationInput added in v1.53.0 

type DeleteContactEvaluationInput struct {

	// A unique identifier for the contact evaluation.
	//
	// This member is required.
	EvaluationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DeleteContactEvaluationOutput added in v1.53.0 

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

type DeleteContactFlowInput added in v1.13.0 

type DeleteContactFlowInput struct {

	// The identifier of the flow.
	//
	// This member is required.
	ContactFlowId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DeleteContactFlowModuleInput added in v1.13.0 

type DeleteContactFlowModuleInput struct {

	// The identifier of the flow module.
	//
	// This member is required.
	ContactFlowModuleId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DeleteContactFlowModuleOutput added in v1.13.0 

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

type DeleteContactFlowOutput added in v1.13.0 

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

type DeleteEvaluationFormInput added in v1.53.0 

type DeleteEvaluationFormInput struct {

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier for the evaluation form.
	EvaluationFormVersion *int32
	// contains filtered or unexported fields
}

type DeleteEvaluationFormOutput added in v1.53.0 

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

type DeleteHoursOfOperationInput added in v1.6.0 

type DeleteHoursOfOperationInput struct {

	// The identifier for the hours of operation.
	//
	// This member is required.
	HoursOfOperationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DeleteHoursOfOperationOutput added in v1.6.0 

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

type DeleteInstanceInput added in v0.30.0 

type DeleteInstanceInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DeleteInstanceOutput added in v0.30.0 

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

type DeleteIntegrationAssociationInput added in v0.31.0 

type DeleteIntegrationAssociationInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the integration association.
	//
	// This member is required.
	IntegrationAssociationId *string
	// contains filtered or unexported fields
}

type DeleteIntegrationAssociationOutput added in v0.31.0 

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

type DeletePredefinedAttributeInput added in v1.87.0 

type DeletePredefinedAttributeInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the predefined attribute.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeletePredefinedAttributeOutput added in v1.87.0 

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

type DeletePromptInput added in v1.55.0 

type DeletePromptInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the prompt.
	//
	// This member is required.
	PromptId *string
	// contains filtered or unexported fields
}

type DeletePromptOutput added in v1.55.0 

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

type DeleteQueueInput added in v1.61.0 

type DeleteQueueInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type DeleteQueueOutput added in v1.61.0 

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

type DeleteQuickConnectInput added in v0.31.0 

type DeleteQuickConnectInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the quick connect.
	//
	// This member is required.
	QuickConnectId *string
	// contains filtered or unexported fields
}

type DeleteQuickConnectOutput added in v0.31.0 

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

type DeleteRoutingProfileInput added in v1.61.0 

type DeleteRoutingProfileInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string
	// contains filtered or unexported fields
}

type DeleteRoutingProfileOutput added in v1.61.0 

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

type DeleteRuleInput added in v1.39.0 

type DeleteRuleInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the rule.
	//
	// This member is required.
	RuleId *string
	// contains filtered or unexported fields
}

type DeleteRuleOutput added in v1.39.0 

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

type DeleteSecurityProfileInput added in v1.11.0 

type DeleteSecurityProfileInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the security profle.
	//
	// This member is required.
	SecurityProfileId *string
	// contains filtered or unexported fields
}

type DeleteSecurityProfileOutput added in v1.11.0 

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

type DeleteTaskTemplateInput added in v1.25.0 

type DeleteTaskTemplateInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the task template.
	//
	// This member is required.
	TaskTemplateId *string
	// contains filtered or unexported fields
}

type DeleteTaskTemplateOutput added in v1.25.0 

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

type DeleteTrafficDistributionGroupInput added in v1.33.0 

type DeleteTrafficDistributionGroupInput struct {

	// The identifier of the traffic distribution group. This can be the ID or the ARN
	// if the API is being called in the Region where the traffic distribution group
	// was created. The ARN must be provided if the call is from the replicated Region.
	//
	// This member is required.
	TrafficDistributionGroupId *string
	// contains filtered or unexported fields
}

type DeleteTrafficDistributionGroupOutput added in v1.33.0 

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

type DeleteUseCaseInput added in v0.31.0 

type DeleteUseCaseInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the integration association.
	//
	// This member is required.
	IntegrationAssociationId *string

	// The identifier for the use case.
	//
	// This member is required.
	UseCaseId *string
	// contains filtered or unexported fields
}

type DeleteUseCaseOutput added in v0.31.0 

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

type DeleteUserHierarchyGroupInput added in v0.30.0 

type DeleteUserHierarchyGroupInput struct {

	// The identifier of the hierarchy group.
	//
	// This member is required.
	HierarchyGroupId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DeleteUserHierarchyGroupOutput added in v0.30.0 

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

type DeleteUserInput 

type DeleteUserInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type DeleteUserOutput 

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

type DeleteViewInput added in v1.66.0 

type DeleteViewInput struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the view. Both ViewArn and ViewId can be used.
	//
	// This member is required.
	ViewId *string
	// contains filtered or unexported fields
}

type DeleteViewOutput added in v1.66.0 

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

type DeleteViewVersionInput added in v1.66.0 

type DeleteViewVersionInput struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the view. Both ViewArn and ViewId can be used.
	//
	// This member is required.
	ViewId *string

	// The version number of the view.
	//
	// This member is required.
	ViewVersion *int32
	// contains filtered or unexported fields
}

type DeleteViewVersionOutput added in v1.66.0 

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

type DeleteVocabularyInput added in v1.17.0 

type DeleteVocabularyInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the custom vocabulary.
	//
	// This member is required.
	VocabularyId *string
	// contains filtered or unexported fields
}

type DeleteVocabularyOutput added in v1.17.0 

type DeleteVocabularyOutput struct {

	// The current state of the custom vocabulary.
	//
	// This member is required.
	State types.VocabularyState

	// The Amazon Resource Name (ARN) of the custom vocabulary.
	//
	// This member is required.
	VocabularyArn *string

	// The identifier of the custom vocabulary.
	//
	// This member is required.
	VocabularyId *string

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

type DescribeAgentStatusInput added in v1.6.0 

type DescribeAgentStatusInput struct {

	// The identifier for the agent status.
	//
	// This member is required.
	AgentStatusId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeAgentStatusOutput added in v1.6.0 

type DescribeAgentStatusOutput struct {

	// The agent status.
	AgentStatus *types.AgentStatus

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

type DescribeContactEvaluationInput added in v1.53.0 

type DescribeContactEvaluationInput struct {

	// A unique identifier for the contact evaluation.
	//
	// This member is required.
	EvaluationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeContactEvaluationOutput added in v1.53.0 

type DescribeContactEvaluationOutput struct {

	// Information about the evaluation form completed for a specific contact.
	//
	// This member is required.
	Evaluation *types.Evaluation

	// Information about the evaluation form.
	//
	// This member is required.
	EvaluationForm *types.EvaluationFormContent

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

type DescribeContactFlowInput added in v0.29.0 

type DescribeContactFlowInput struct {

	// The identifier of the flow.
	//
	// This member is required.
	ContactFlowId *string

	// The identifier of the Amazon Connect instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeContactFlowModuleInput added in v1.13.0 

type DescribeContactFlowModuleInput struct {

	// The identifier of the flow module.
	//
	// This member is required.
	ContactFlowModuleId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeContactFlowModuleOutput added in v1.13.0 

type DescribeContactFlowModuleOutput struct {

	// Information about the flow module.
	ContactFlowModule *types.ContactFlowModule

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

type DescribeContactFlowOutput added in v0.29.0 

type DescribeContactFlowOutput struct {

	// Information about the flow.
	ContactFlow *types.ContactFlow

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

type DescribeContactInput added in v1.12.0 

type DescribeContactInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeContactOutput added in v1.12.0 

type DescribeContactOutput struct {

	// Information about the contact.
	Contact *types.Contact

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

type DescribeEvaluationFormInput added in v1.53.0 

type DescribeEvaluationFormInput struct {

	// A unique identifier for the contact evaluation.
	//
	// This member is required.
	EvaluationFormId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A version of the evaluation form.
	EvaluationFormVersion *int32
	// contains filtered or unexported fields
}

type DescribeEvaluationFormOutput added in v1.53.0 

type DescribeEvaluationFormOutput struct {

	// Information about the evaluation form.
	//
	// This member is required.
	EvaluationForm *types.EvaluationForm

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

type DescribeHoursOfOperationInput added in v1.2.0 

type DescribeHoursOfOperationInput struct {

	// The identifier for the hours of operation.
	//
	// This member is required.
	HoursOfOperationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeHoursOfOperationOutput added in v1.2.0 

type DescribeHoursOfOperationOutput struct {

	// The hours of operation.
	HoursOfOperation *types.HoursOfOperation

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

type DescribeInstanceAttributeInput added in v0.30.0 

type DescribeInstanceAttributeInput struct {

	// The type of attribute.
	//
	// This member is required.
	AttributeType types.InstanceAttributeType

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeInstanceAttributeOutput added in v0.30.0 

type DescribeInstanceAttributeOutput struct {

	// The type of attribute.
	Attribute *types.Attribute

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

type DescribeInstanceInput added in v0.30.0 

type DescribeInstanceInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeInstanceOutput added in v0.30.0 

type DescribeInstanceOutput struct {

	// The name of the instance.
	Instance *types.Instance

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

type DescribeInstanceStorageConfigInput added in v0.30.0 

type DescribeInstanceStorageConfigInput struct {

	// The existing association identifier that uniquely identifies the resource type
	// and storage config for the given instance ID.
	//
	// This member is required.
	AssociationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A valid resource type.
	//
	// This member is required.
	ResourceType types.InstanceStorageResourceType
	// contains filtered or unexported fields
}

type DescribeInstanceStorageConfigOutput added in v0.30.0 

type DescribeInstanceStorageConfigOutput struct {

	// A valid storage type.
	StorageConfig *types.InstanceStorageConfig

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

type DescribePhoneNumberInput added in v1.22.0 

type DescribePhoneNumberInput struct {

	// A unique identifier for the phone number.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type DescribePhoneNumberOutput added in v1.22.0 

type DescribePhoneNumberOutput struct {

	// Information about a phone number that's been claimed to your Amazon Connect
	// instance or traffic distribution group.
	ClaimedPhoneNumberSummary *types.ClaimedPhoneNumberSummary

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

type DescribePredefinedAttributeInput added in v1.87.0 

type DescribePredefinedAttributeInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the predefined attribute.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DescribePredefinedAttributeOutput added in v1.87.0 

type DescribePredefinedAttributeOutput struct {

	// Information about the predefined attribute.
	PredefinedAttribute *types.PredefinedAttribute

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

type DescribePromptInput added in v1.55.0 

type DescribePromptInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the prompt.
	//
	// This member is required.
	PromptId *string
	// contains filtered or unexported fields
}

type DescribePromptOutput added in v1.55.0 

type DescribePromptOutput struct {

	// Information about the prompt.
	Prompt *types.Prompt

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

type DescribeQueueInput added in v1.2.0 

type DescribeQueueInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type DescribeQueueOutput added in v1.2.0 

type DescribeQueueOutput struct {

	// The name of the queue.
	Queue *types.Queue

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

type DescribeQuickConnectInput added in v0.31.0 

type DescribeQuickConnectInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the quick connect.
	//
	// This member is required.
	QuickConnectId *string
	// contains filtered or unexported fields
}

type DescribeQuickConnectOutput added in v0.31.0 

type DescribeQuickConnectOutput struct {

	// Information about the quick connect.
	QuickConnect *types.QuickConnect

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

type DescribeRoutingProfileInput added in v0.29.0 

type DescribeRoutingProfileInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string
	// contains filtered or unexported fields
}

type DescribeRoutingProfileOutput added in v0.29.0 

type DescribeRoutingProfileOutput struct {

	// The routing profile.
	RoutingProfile *types.RoutingProfile

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

type DescribeRuleInput added in v1.39.0 

type DescribeRuleInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the rule.
	//
	// This member is required.
	RuleId *string
	// contains filtered or unexported fields
}

type DescribeRuleOutput added in v1.39.0 

type DescribeRuleOutput struct {

	// Information about the rule.
	//
	// This member is required.
	Rule *types.Rule

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

type DescribeSecurityProfileInput added in v1.11.0 

type DescribeSecurityProfileInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the security profle.
	//
	// This member is required.
	SecurityProfileId *string
	// contains filtered or unexported fields
}

type DescribeSecurityProfileOutput added in v1.11.0 

type DescribeSecurityProfileOutput struct {

	// The security profile.
	SecurityProfile *types.SecurityProfile

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

type DescribeTrafficDistributionGroupInput added in v1.33.0 

type DescribeTrafficDistributionGroupInput struct {

	// The identifier of the traffic distribution group. This can be the ID or the ARN
	// if the API is being called in the Region where the traffic distribution group
	// was created. The ARN must be provided if the call is from the replicated Region.
	//
	// This member is required.
	TrafficDistributionGroupId *string
	// contains filtered or unexported fields
}

type DescribeTrafficDistributionGroupOutput added in v1.33.0 

type DescribeTrafficDistributionGroupOutput struct {

	// Information about the traffic distribution group.
	TrafficDistributionGroup *types.TrafficDistributionGroup

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

type DescribeUserHierarchyGroupInput 

type DescribeUserHierarchyGroupInput struct {

	// The identifier of the hierarchy group.
	//
	// This member is required.
	HierarchyGroupId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeUserHierarchyGroupOutput 

type DescribeUserHierarchyGroupOutput struct {

	// Information about the hierarchy group.
	HierarchyGroup *types.HierarchyGroup

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

type DescribeUserHierarchyStructureInput 

type DescribeUserHierarchyStructureInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DescribeUserHierarchyStructureOutput 

type DescribeUserHierarchyStructureOutput struct {

	// Information about the hierarchy structure.
	HierarchyStructure *types.HierarchyStructure

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

type DescribeUserInput 

type DescribeUserInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type DescribeUserOutput 

type DescribeUserOutput struct {

	// Information about the user account and configuration settings.
	User *types.User

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

type DescribeViewInput added in v1.66.0 

type DescribeViewInput struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The ViewId of the view. This must be an ARN for Amazon Web Services managed
	// views.
	//
	// This member is required.
	ViewId *string
	// contains filtered or unexported fields
}

type DescribeViewOutput added in v1.66.0 

type DescribeViewOutput struct {

	// All view data is contained within the View object.
	View *types.View

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

type DescribeVocabularyInput added in v1.17.0 

type DescribeVocabularyInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the custom vocabulary.
	//
	// This member is required.
	VocabularyId *string
	// contains filtered or unexported fields
}

type DescribeVocabularyOutput added in v1.17.0 

type DescribeVocabularyOutput struct {

	// A list of specific words that you want Contact Lens for Amazon Connect to
	// recognize in your audio input. They are generally domain-specific words and
	// phrases, words that Contact Lens is not recognizing, or proper nouns.
	//
	// This member is required.
	Vocabulary *types.Vocabulary

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

type DisassociateAnalyticsDataSetInput added in v1.82.0 

type DisassociateAnalyticsDataSetInput struct {

	// The identifier of the dataset to remove.
	//
	// This member is required.
	DataSetId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the target account. Use to associate a dataset to a different
	// account than the one containing the Amazon Connect instance. If not specified,
	// by default this value is the Amazon Web Services account that has the Amazon
	// Connect instance.
	TargetAccountId *string
	// contains filtered or unexported fields
}

type DisassociateAnalyticsDataSetOutput added in v1.82.0 

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

type DisassociateApprovedOriginInput added in v0.30.0 

type DisassociateApprovedOriginInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The domain URL of the integrated application.
	//
	// This member is required.
	Origin *string
	// contains filtered or unexported fields
}

type DisassociateApprovedOriginOutput added in v0.30.0 

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

type DisassociateBotInput added in v1.5.0 

type DisassociateBotInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Configuration information of an Amazon Lex bot.
	LexBot *types.LexBot

	// The Amazon Lex V2 bot to disassociate from the instance.
	LexV2Bot *types.LexV2Bot
	// contains filtered or unexported fields
}

type DisassociateBotOutput added in v1.5.0 

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

type DisassociateFlowInput added in v1.82.0 

type DisassociateFlowInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the resource.
	//
	// This member is required.
	ResourceId *string

	// A valid resource type.
	//
	// This member is required.
	ResourceType types.FlowAssociationResourceType
	// contains filtered or unexported fields
}

type DisassociateFlowOutput added in v1.82.0 

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

type DisassociateInstanceStorageConfigInput added in v0.30.0 

type DisassociateInstanceStorageConfigInput struct {

	// The existing association identifier that uniquely identifies the resource type
	// and storage config for the given instance ID.
	//
	// This member is required.
	AssociationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A valid resource type.
	//
	// This member is required.
	ResourceType types.InstanceStorageResourceType
	// contains filtered or unexported fields
}

type DisassociateInstanceStorageConfigOutput added in v0.30.0 

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

type DisassociateLambdaFunctionInput added in v0.30.0 

type DisassociateLambdaFunctionInput struct {

	// The Amazon Resource Name (ARN) of the Lambda function being disassociated.
	//
	// This member is required.
	FunctionArn *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance..
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DisassociateLambdaFunctionOutput added in v0.30.0 

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

type DisassociateLexBotInput added in v0.30.0 

type DisassociateLexBotInput struct {

	// The name of the Amazon Lex bot. Maximum character limit of 50.
	//
	// This member is required.
	BotName *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The Amazon Web Services Region in which the Amazon Lex bot has been created.
	//
	// This member is required.
	LexRegion *string
	// contains filtered or unexported fields
}

type DisassociateLexBotOutput added in v0.30.0 

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

type DisassociatePhoneNumberContactFlowInput added in v1.22.0 

type DisassociatePhoneNumberContactFlowInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the phone number.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type DisassociatePhoneNumberContactFlowOutput added in v1.22.0 

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

type DisassociateQueueQuickConnectsInput added in v1.2.0 

type DisassociateQueueQuickConnectsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string

	// The quick connects to disassociate from the queue.
	//
	// This member is required.
	QuickConnectIds []string
	// contains filtered or unexported fields
}

type DisassociateQueueQuickConnectsOutput added in v1.2.0 

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

type DisassociateRoutingProfileQueuesInput added in v0.29.0 

type DisassociateRoutingProfileQueuesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The queues to disassociate from this routing profile.
	//
	// This member is required.
	QueueReferences []types.RoutingProfileQueueReference

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string
	// contains filtered or unexported fields
}

type DisassociateRoutingProfileQueuesOutput added in v0.29.0 

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

type DisassociateSecurityKeyInput added in v0.30.0 

type DisassociateSecurityKeyInput struct {

	// The existing association identifier that uniquely identifies the resource type
	// and storage config for the given instance ID.
	//
	// This member is required.
	AssociationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DisassociateSecurityKeyOutput added in v0.30.0 

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

type DisassociateTrafficDistributionGroupUserInput added in v1.65.0 

type DisassociateTrafficDistributionGroupUserInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the traffic distribution group. This can be the ID or the ARN
	// if the API is being called in the Region where the traffic distribution group
	// was created. The ARN must be provided if the call is from the replicated Region.
	//
	// This member is required.
	TrafficDistributionGroupId *string

	// The identifier for the user. This can be the ID or the ARN of the user.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type DisassociateTrafficDistributionGroupUserOutput added in v1.65.0 

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

type DisassociateUserProficienciesInput added in v1.87.0 

type DisassociateUserProficienciesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string

	// The proficiencies to disassociate from the user.
	//
	// This member is required.
	UserProficiencies []types.UserProficiencyDisassociate
	// contains filtered or unexported fields
}

type DisassociateUserProficienciesOutput added in v1.87.0 

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

type DismissUserContactInput added in v1.34.0 

type DismissUserContactInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type DismissUserContactOutput added in v1.34.0 

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

type EndpointParameters added in v1.63.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.63.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.63.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 added in v1.1.0 

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 added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.63.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.63.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetContactAttributesInput 

type GetContactAttributesInput struct {

	// The identifier of the initial contact.
	//
	// This member is required.
	InitialContactId *string

	// The identifier of the Amazon Connect instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type GetContactAttributesOutput 

type GetContactAttributesOutput struct {

	// Information about the attributes.
	Attributes map[string]string

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

type GetCurrentMetricDataAPIClient added in v0.30.0 

type GetCurrentMetricDataAPIClient interface {
	GetCurrentMetricData(context.Context, *GetCurrentMetricDataInput, ...func(*Options)) (*GetCurrentMetricDataOutput, error)
}

GetCurrentMetricDataAPIClient is a client that implements the GetCurrentMetricData operation.

type GetCurrentMetricDataInput 

type GetCurrentMetricDataInput struct {

	// The metrics to retrieve. Specify the name and unit for each metric. The
	// following metrics are available. For a description of all the metrics, see
	// Real-time Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html)
	// in the Amazon Connect Administrator Guide. AGENTS_AFTER_CONTACT_WORK Unit: COUNT
	// Name in real-time metrics report: ACW (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time)
	// AGENTS_AVAILABLE Unit: COUNT Name in real-time metrics report: Available (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time)
	// AGENTS_ERROR Unit: COUNT Name in real-time metrics report: Error (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time)
	// AGENTS_NON_PRODUCTIVE Unit: COUNT Name in real-time metrics report: NPT
	// (Non-Productive Time) (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time)
	// AGENTS_ON_CALL Unit: COUNT Name in real-time metrics report: On contact (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time)
	// AGENTS_ON_CONTACT Unit: COUNT Name in real-time metrics report: On contact (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time)
	// AGENTS_ONLINE Unit: COUNT Name in real-time metrics report: Online (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time)
	// AGENTS_STAFFED Unit: COUNT Name in real-time metrics report: Staffed (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time)
	// CONTACTS_IN_QUEUE Unit: COUNT Name in real-time metrics report: In queue (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time)
	// CONTACTS_SCHEDULED Unit: COUNT Name in real-time metrics report: Scheduled (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time)
	// OLDEST_CONTACT_AGE Unit: SECONDS When you use groupings, Unit says SECONDS and
	// the Value is returned in SECONDS. When you do not use groupings, Unit says
	// SECONDS but the Value is returned in MILLISECONDS. For example, if you get a
	// response like this: { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit":
	// "SECONDS" }, "Value": 24113.0 } The actual OLDEST_CONTACT_AGE is 24 seconds.
	// When the filter RoutingStepExpression is used, this metric is still calculated
	// from enqueue time. For example, if a contact that has been queued under for 10
	// seconds has expired and becomes active, then OLDEST_CONTACT_AGE for this queue
	// will be counted starting from 10, not 0. Name in real-time metrics report:
	// Oldest (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time)
	// SLOTS_ACTIVE Unit: COUNT Name in real-time metrics report: Active (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time)
	// SLOTS_AVAILABLE Unit: COUNT Name in real-time metrics report: Availability (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time)
	//
	// This member is required.
	CurrentMetrics []types.CurrentMetric

	// The filters to apply to returned metrics. You can filter up to the following
	// limits:
	//   - Queues: 100
	//   - Routing profiles: 100
	//   - Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
	//   - RoutingStepExpressions: 50
	// Metric data is retrieved only for the resources associated with the queues or
	// routing profiles, and by any channels included in the filter. (You cannot filter
	// by both queue AND routing profile.) You can include both resource IDs and
	// resource ARNs in the same request. When using the RoutingStepExpression filter,
	// you need to pass exactly one QueueId . The filter is also case sensitive so when
	// using the RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is
	// required. Currently tagging is only supported on the resources that are passed
	// in the filter.
	//
	// This member is required.
	Filters *types.Filters

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The grouping applied to the metrics returned. For example, when grouped by QUEUE
	// , the metrics returned apply to each queue rather than aggregated for all
	// queues.
	//   - If you group by CHANNEL , you should include a Channels filter. VOICE, CHAT,
	//   and TASK channels are supported.
	//   - If you group by ROUTING_PROFILE , you must include either a queue or routing
	//   profile filter. In addition, a routing profile filter is required for metrics
	//   CONTACTS_SCHEDULED , CONTACTS_IN_QUEUE , and OLDEST_CONTACT_AGE .
	//   - If no Grouping is included in the request, a summary of metrics is returned.
	//   - When using the RoutingStepExpression filter, group by
	//   ROUTING_STEP_EXPRESSION is required.
	Groupings []types.Grouping

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results. The token
	// expires after 5 minutes from the time it is created. Subsequent requests that
	// use the token must use the same request parameters as the request that generated
	// the token.
	NextToken *string

	// The way to sort the resulting response based on metrics. You can enter one sort
	// criteria. By default resources are sorted based on AGENTS_ONLINE , DESCENDING .
	// The metric collection is sorted based on the input metrics. Note the following:
	//   - Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
	SortCriteria []types.CurrentMetricSortCriteria
	// contains filtered or unexported fields
}

type GetCurrentMetricDataOutput 

type GetCurrentMetricDataOutput struct {

	// The total count of the result, regardless of the current page size.
	ApproximateTotalCount *int64

	// The time at which the metrics were retrieved and cached for pagination.
	DataSnapshotTime *time.Time

	// Information about the real-time metrics.
	MetricResults []types.CurrentMetricResult

	// If there are additional results, this is the token for the next set of results.
	// The token expires after 5 minutes from the time it is created. Subsequent
	// requests that use the token must use the same request parameters as the request
	// that generated the token.
	NextToken *string

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

type GetCurrentMetricDataPaginator added in v0.30.0 

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

GetCurrentMetricDataPaginator is a paginator for GetCurrentMetricData

func NewGetCurrentMetricDataPaginator added in v0.30.0 

func NewGetCurrentMetricDataPaginator(client GetCurrentMetricDataAPIClient, params *GetCurrentMetricDataInput, optFns ...func(*GetCurrentMetricDataPaginatorOptions)) *GetCurrentMetricDataPaginator

NewGetCurrentMetricDataPaginator returns a new GetCurrentMetricDataPaginator

func (*GetCurrentMetricDataPaginator) HasMorePages added in v0.30.0 

func (p *GetCurrentMetricDataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetCurrentMetricDataPaginator) NextPage added in v0.30.0 

func (p *GetCurrentMetricDataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetCurrentMetricDataOutput, error)

NextPage retrieves the next GetCurrentMetricData page.

type GetCurrentMetricDataPaginatorOptions added in v0.30.0 

type GetCurrentMetricDataPaginatorOptions 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
}

GetCurrentMetricDataPaginatorOptions is the paginator options for GetCurrentMetricData

type GetCurrentUserDataAPIClient added in v1.26.0 

type GetCurrentUserDataAPIClient interface {
	GetCurrentUserData(context.Context, *GetCurrentUserDataInput, ...func(*Options)) (*GetCurrentUserDataOutput, error)
}

GetCurrentUserDataAPIClient is a client that implements the GetCurrentUserData operation.

type GetCurrentUserDataInput added in v1.26.0 

type GetCurrentUserDataInput struct {

	// The filters to apply to returned user data. You can filter up to the following
	// limits:
	//   - Queues: 100
	//   - Routing profiles: 100
	//   - Agents: 100
	//   - Contact states: 9
	//   - User hierarchy groups: 1
	// The user data is retrieved for only the specified values/resources in the
	// filter. A maximum of one filter can be passed from queues, routing profiles,
	// agents, and user hierarchy groups. Currently tagging is only supported on the
	// resources that are passed in the filter.
	//
	// This member is required.
	Filters *types.UserDataFilters

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetCurrentUserDataOutput added in v1.26.0 

type GetCurrentUserDataOutput struct {

	// The total count of the result, regardless of the current page size.
	ApproximateTotalCount *int64

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// A list of the user data that is returned.
	UserDataList []types.UserData

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

type GetCurrentUserDataPaginator added in v1.26.0 

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

GetCurrentUserDataPaginator is a paginator for GetCurrentUserData

func NewGetCurrentUserDataPaginator added in v1.26.0 

func NewGetCurrentUserDataPaginator(client GetCurrentUserDataAPIClient, params *GetCurrentUserDataInput, optFns ...func(*GetCurrentUserDataPaginatorOptions)) *GetCurrentUserDataPaginator

NewGetCurrentUserDataPaginator returns a new GetCurrentUserDataPaginator

func (*GetCurrentUserDataPaginator) HasMorePages added in v1.26.0 

func (p *GetCurrentUserDataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetCurrentUserDataPaginator) NextPage added in v1.26.0 

func (p *GetCurrentUserDataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetCurrentUserDataOutput, error)

NextPage retrieves the next GetCurrentUserData page.

type GetCurrentUserDataPaginatorOptions added in v1.26.0 

type GetCurrentUserDataPaginatorOptions 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
}

GetCurrentUserDataPaginatorOptions is the paginator options for GetCurrentUserData

type GetFederationTokenInput 

type GetFederationTokenInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type GetFederationTokenOutput 

type GetFederationTokenOutput struct {

	// The credentials to use for federation.
	Credentials *types.Credentials

	// The URL to sign into the user's instance.
	SignInUrl *string

	// The Amazon Resource Name (ARN) of the user.
	UserArn *string

	// The identifier for the user. This can be the ID or the ARN of the user.
	UserId *string

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

type GetFlowAssociationInput added in v1.82.0 

type GetFlowAssociationInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the resource.
	//
	// This member is required.
	ResourceId *string

	// A valid resource type.
	//
	// This member is required.
	ResourceType types.FlowAssociationResourceType
	// contains filtered or unexported fields
}

type GetFlowAssociationOutput added in v1.82.0 

type GetFlowAssociationOutput struct {

	// The identifier of the flow.
	FlowId *string

	// The identifier of the resource.
	ResourceId *string

	// A valid resource type.
	ResourceType types.FlowAssociationResourceType

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

type GetMetricDataAPIClient added in v0.30.0 

type GetMetricDataAPIClient interface {
	GetMetricData(context.Context, *GetMetricDataInput, ...func(*Options)) (*GetMetricDataOutput, error)
}

GetMetricDataAPIClient is a client that implements the GetMetricData operation.

type GetMetricDataInput 

type GetMetricDataInput struct {

	// The timestamp, in UNIX Epoch time format, at which to end the reporting
	// interval for the retrieval of historical metrics data. The time must be
	// specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must
	// be later than the start time timestamp. The time range between the start and end
	// time must be less than 24 hours.
	//
	// This member is required.
	EndTime *time.Time

	// The queues, up to 100, or channels, to use to filter the metrics returned.
	// Metric data is retrieved only for the resources associated with the queues or
	// channels included in the filter. You can include both queue IDs and queue ARNs
	// in the same request. VOICE, CHAT, and TASK channels are supported.
	// RoutingStepExpression is not a valid filter for GetMetricData and we recommend
	// switching to GetMetricDataV2 for more up-to-date features. To filter by Queues ,
	// enter the queue ID/ARN, not the name of the queue.
	//
	// This member is required.
	Filters *types.Filters

	// The metrics to retrieve. Specify the name, unit, and statistic for each metric.
	// The following historical metrics are available. For a description of each
	// metric, see Historical Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html)
	// in the Amazon Connect Administrator Guide. This API does not support a contacts
	// incoming metric (there's no CONTACTS_INCOMING metric missing from the documented
	// list). ABANDON_TIME Unit: SECONDS Statistic: AVG AFTER_CONTACT_WORK_TIME Unit:
	// SECONDS Statistic: AVG API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM
	// CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM CONTACTS_ABANDONED Unit:
	// COUNT Statistic: SUM CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM
	// CONTACTS_CONSULTED Unit: COUNT Statistic: SUM CONTACTS_HANDLED Unit: COUNT
	// Statistic: SUM CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM
	// CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM CONTACTS_HOLD_ABANDONS
	// Unit: COUNT Statistic: SUM CONTACTS_MISSED Unit: COUNT Statistic: SUM
	// CONTACTS_QUEUED Unit: COUNT Statistic: SUM CONTACTS_TRANSFERRED_IN Unit: COUNT
	// Statistic: SUM CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM
	// CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM
	// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM HANDLE_TIME Unit:
	// SECONDS Statistic: AVG HOLD_TIME Unit: SECONDS Statistic: AVG
	// INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG INTERACTION_TIME Unit:
	// SECONDS Statistic: AVG OCCUPANCY Unit: PERCENT Statistic: AVG QUEUE_ANSWER_TIME
	// Unit: SECONDS Statistic: AVG QUEUED_TIME Unit: SECONDS Statistic: MAX
	// SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit:
	// PERCENT Statistic: AVG Threshold: For ThresholdValue , enter any whole number
	// from 1 to 604800 (inclusive), in seconds. For Comparison , you must enter LT
	// (for "Less than").
	//
	// This member is required.
	HistoricalMetrics []types.HistoricalMetric

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The timestamp, in UNIX Epoch time format, at which to start the reporting
	// interval for the retrieval of historical metrics data. The time must be
	// specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15. The start
	// time cannot be earlier than 24 hours before the time of the request. Historical
	// metrics are available only for 24 hours.
	//
	// This member is required.
	StartTime *time.Time

	// The grouping applied to the metrics returned. For example, when results are
	// grouped by queue, the metrics returned are grouped by queue. The values returned
	// apply to the metrics for each queue rather than aggregated for all queues. If no
	// grouping is specified, a summary of metrics for all queues is returned.
	// RoutingStepExpression is not a valid filter for GetMetricData and we recommend
	// switching to GetMetricDataV2 for more up-to-date features.
	Groupings []types.Grouping

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetMetricDataOutput 

type GetMetricDataOutput struct {

	// Information about the historical metrics. If no grouping is specified, a
	// summary of metric data is returned.
	MetricResults []types.HistoricalMetricResult

	// If there are additional results, this is the token for the next set of results.
	// The token expires after 5 minutes from the time it is created. Subsequent
	// requests that use the token must use the same request parameters as the request
	// that generated the token.
	NextToken *string

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

type GetMetricDataPaginator added in v0.30.0 

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

GetMetricDataPaginator is a paginator for GetMetricData

func NewGetMetricDataPaginator added in v0.30.0 

func NewGetMetricDataPaginator(client GetMetricDataAPIClient, params *GetMetricDataInput, optFns ...func(*GetMetricDataPaginatorOptions)) *GetMetricDataPaginator

NewGetMetricDataPaginator returns a new GetMetricDataPaginator

func (*GetMetricDataPaginator) HasMorePages added in v0.30.0 

func (p *GetMetricDataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetMetricDataPaginator) NextPage added in v0.30.0 

func (p *GetMetricDataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetMetricDataOutput, error)

NextPage retrieves the next GetMetricData page.

type GetMetricDataPaginatorOptions added in v0.30.0 

type GetMetricDataPaginatorOptions 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
}

GetMetricDataPaginatorOptions is the paginator options for GetMetricData

type GetMetricDataV2APIClient added in v1.49.0 

type GetMetricDataV2APIClient interface {
	GetMetricDataV2(context.Context, *GetMetricDataV2Input, ...func(*Options)) (*GetMetricDataV2Output, error)
}

GetMetricDataV2APIClient is a client that implements the GetMetricDataV2 operation.

type GetMetricDataV2Input added in v1.49.0 

type GetMetricDataV2Input struct {

	// The timestamp, in UNIX Epoch time format, at which to end the reporting
	// interval for the retrieval of historical metrics data. The time must be later
	// than the start time timestamp. It cannot be later than the current timestamp.
	//
	// This member is required.
	EndTime *time.Time

	// The filters to apply to returned metrics. You can filter on the following
	// resources:
	//   - Queues
	//   - Routing profiles
	//   - Agents
	//   - Channels
	//   - User hierarchy groups
	//   - Feature
	//   - Routing step expression
	// At least one filter must be passed from queues, routing profiles, agents, or
	// user hierarchy groups. To filter by phone number, see Create a historical
	// metrics report (https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html)
	// in the Amazon Connect Administrator's Guide. Note the following limits:
	//   - Filter keys: A maximum of 5 filter keys are supported in a single request.
	//   Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL |
	//   AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO |
	//   AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR |
	//   AGENT_HIERARCHY_LEVEL_FIVE | FEATURE | CASE_TEMPLATE_ARN | CASE_STATUS |
	//   contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
	//   - Filter values: A maximum of 100 filter values are supported in a single
	//   request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter
	//   key. They do not count towards limitation of 100 filter values. For example, a
	//   GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing
	//   profiles for a total of 100 filter values, along with 3 channel filters.
	//   contact_lens_conversational_analytics is a valid filterValue for the FEATURE
	//   filter key. It is available only to contacts analyzed by Contact Lens
	//   conversational analytics. connect:Chat , connect:SMS , connect:Telephony , and
	//   connect:WebRTC are valid filterValue examples (not exhaustive) for the
	//   contact/segmentAttributes/connect:Subtype filter key. ROUTING_STEP_EXPRESSION
	//   is a valid filter key with a filter value up to 3000 length. This filter is case
	//   and order sensitive. JSON string fields must be sorted in ascending order and
	//   JSON array order should be kept as is.
	//
	// This member is required.
	Filters []types.FilterV2

	// The metrics to retrieve. Specify the name, groupings, and filters for each
	// metric. The following historical metrics are available. For a description of
	// each metric, see Historical metrics definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html)
	// in the Amazon Connect Administrator's Guide. ABANDONMENT_RATE Unit: Percent
	// Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent
	// Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name:
	// Abandonment rate (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#abandonment-rate-historical)
	// AGENT_ADHERENT_TIME This metric is available only in Amazon Web Services Regions
	// where Forecasting, capacity planning, and scheduling (https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region)
	// is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing
	// Profile, Agent, Agent Hierarchy UI name: Adherent time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherent-time-historical)
	// AGENT_ANSWER_RATE Unit: Percent Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy UI name: Agent answer rate (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-answer-rate-historical)
	// AGENT_NON_ADHERENT_TIME Unit: Seconds Valid groupings and filters: Queue,
	// Channel, Routing Profile, Agent, Agent Hierarchy UI name: Non-adherent time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#non-adherent-time)
	// AGENT_NON_RESPONSE Unit: Count Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy UI name: Agent non-response (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-non-response)
	// AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS Unit: Count Valid groupings and
	// filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy Data for this
	// metric is available starting from October 1, 2023 0:00:00 GMT. UI name: Agent
	// non-response without customer abandons (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-nonresponse-no-abandon-historical)
	// AGENT_OCCUPANCY Unit: Percentage Valid groupings and filters: Routing Profile,
	// Agent, Agent Hierarchy UI name: Occupancy (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#occupancy-historical)
	// AGENT_SCHEDULE_ADHERENCE This metric is available only in Amazon Web Services
	// Regions where Forecasting, capacity planning, and scheduling (https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region)
	// is available. Unit: Percent Valid groupings and filters: Queue, Channel, Routing
	// Profile, Agent, Agent Hierarchy UI name: Adherence (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherence-historical)
	// AGENT_SCHEDULED_TIME This metric is available only in Amazon Web Services
	// Regions where Forecasting, capacity planning, and scheduling (https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region)
	// is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing
	// Profile, Agent, Agent Hierarchy UI name: Scheduled time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#scheduled-time-historical)
	// AVG_ABANDON_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy, Feature,
	// contact/segmentAttributes/connect:Subtype UI name: Average queue abandon time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-abandon-time-historical)
	// AVG_ACTIVE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy UI name: Average active time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-active-time-historical)
	// AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid metric filter key:
	// INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile,
	// Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI
	// name: Average after contact work time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-acw-time-historical)
	// Feature is a valid filter but not a valid grouping. AVG_AGENT_CONNECTING_TIME
	// Unit: Seconds Valid metric filter key: INITIATION_METHOD . For now, this metric
	// only supports the following as INITIATION_METHOD : INBOUND | OUTBOUND | CALLBACK
	// | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
	// Agent Hierarchy UI name: Average agent API connecting time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-avg-agent-api-connecting-time)
	// The Negate key in Metric Level Filters is not applicable for this metric.
	// AVG_AGENT_PAUSE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy UI name: Average agent pause time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-pause-time-historical)
	// AVG_CASE_RELATED_CONTACTS Unit: Count Required filter key: CASE_TEMPLATE_ARN
	// Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average
	// contacts per case (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contacts-case-historical)
	// AVG_CASE_RESOLUTION_TIME Unit: Seconds Required filter key: CASE_TEMPLATE_ARN
	// Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average
	// case resolution time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-case-resolution-time-historical)
	// AVG_CONTACT_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy, Feature,
	// contact/segmentAttributes/connect:Subtype UI name: Average contact duration (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contact-duration-historical)
	// Feature is a valid filter but not a valid grouping. AVG_CONVERSATION_DURATION
	// Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile,
	// Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI
	// name: Average conversation duration (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical)
	// AVG_GREETING_TIME_AGENT This metric is available only for contacts analyzed by
	// Contact Lens conversational analytics. Unit: Seconds Valid groupings and
	// filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Average greeting time agent  (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical)
	// AVG_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy, Feature,
	// contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name:
	// Average handle time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-handle-time-historical)
	// Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME Unit: Seconds
	// Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent
	// Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average
	// customer hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-customer-hold-time-historical)
	// Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME_ALL_CONTACTS
	// Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile,
	// Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name:
	// Average customer hold time all contacts (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#avg-customer-hold-time-all-contacts-historical)
	// AVG_HOLDS Unit: Count Valid groupings and filters: Queue, Channel, Routing
	// Profile, Agent, Agent Hierarchy, Feature,
	// contact/segmentAttributes/connect:Subtype UI name: Average holds (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-holds-historical)
	// Feature is a valid filter but not a valid grouping.
	// AVG_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue,
	// Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Average agent interaction
	// and customer hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-customer-hold-time-historical)
	// AVG_INTERACTION_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD
	// Valid groupings and filters: Queue, Channel, Routing Profile, Feature,
	// contact/segmentAttributes/connect:Subtype UI name: Average agent interaction
	// time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-time-historical)
	// Feature is a valid filter but not a valid grouping. AVG_INTERRUPTIONS_AGENT This
	// metric is available only for contacts analyzed by Contact Lens conversational
	// analytics. Unit: Count Valid groupings and filters: Queue, Channel, Routing
	// Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI
	// name: Average interruptions agent  (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical)
	// AVG_INTERRUPTION_TIME_AGENT This metric is available only for contacts analyzed
	// by Contact Lens conversational analytics. Unit: Seconds Valid groupings and
	// filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Average interruption time
	// agent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical)
	// AVG_NON_TALK_TIME This metric is available only for contacts analyzed by Contact
	// Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue,
	// Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Average non-talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##average-non-talk-time-historical)
	// AVG_QUEUE_ANSWER_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name:
	// Average queue answer time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-answer-time-historical)
	// Feature is a valid filter but not a valid grouping. AVG_RESOLUTION_TIME Unit:
	// Seconds Valid groupings and filters: Queue, Channel, Routing Profile,
	// contact/segmentAttributes/connect:Subtype UI name: Average resolution time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-resolution-time-historical)
	// AVG_TALK_TIME This metric is available only for contacts analyzed by Contact
	// Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue,
	// Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Average talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-historical)
	// AVG_TALK_TIME_AGENT This metric is available only for contacts analyzed by
	// Contact Lens conversational analytics. Unit: Seconds Valid groupings and
	// filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Average talk time agent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical)
	// AVG_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by
	// Contact Lens conversational analytics. Unit: Seconds Valid groupings and
	// filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Average talk time customer (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical)
	// CASES_CREATED Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings
	// and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases created (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##cases-created-historical)
	// CONTACTS_ABANDONED Unit: Count Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name:
	// Contact abandoned (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical)
	// CONTACTS_CREATED Unit: Count Valid metric filter key: INITIATION_METHOD Valid
	// groupings and filters: Queue, Channel, Routing Profile, Feature,
	// contact/segmentAttributes/connect:Subtype UI name: Contacts created (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical)
	// Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED Unit: Count
	// Valid metric filter key: INITIATION_METHOD , DISCONNECT_REASON Valid groupings
	// and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
	// contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: API
	// contacts handled (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical)
	// Feature is a valid filter but not a valid grouping.
	// CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT Unit: Count Valid metric filter key:
	// INITIATION_METHOD Valid groupings and filters: Queue, Channel, Agent, Agent
	// Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts handled
	// by Connected to agent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical)
	// CONTACTS_HOLD_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Contacts hold disconnect (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical)
	// CONTACTS_ON_HOLD_AGENT_DISCONNECT Unit: Count Valid groupings and filters:
	// Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold
	// agent disconnect (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical)
	// CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT Unit: Count Valid groupings and filters:
	// Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold
	// customer disconnect (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical)
	// CONTACTS_PUT_ON_HOLD Unit: Count Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy UI name: Contacts put on hold (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical)
	// CONTACTS_TRANSFERRED_OUT_EXTERNAL Unit: Count Valid groupings and filters:
	// Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts
	// transferred out external (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical)
	// CONTACTS_TRANSFERRED_OUT_INTERNAL Unit: Percent Valid groupings and filters:
	// Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts
	// transferred out internal (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical)
	// CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, Channel, Routing
	// Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI
	// name: Contacts queued (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical)
	// CONTACTS_QUEUED_BY_ENQUEUE Unit: Count Valid groupings and filters: Queue,
	// Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI
	// name: Contacts queued by Enqueue (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical)
	// CONTACTS_RESOLVED_IN_X Unit: Count Valid groupings and filters: Queue, Channel,
	// Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For
	// ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds.
	// For Comparison , you must enter LT (for "Less than"). UI name: Contacts
	// resolved in X (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical)
	// CONTACTS_TRANSFERRED_OUT Unit: Count Valid groupings and filters: Queue,
	// Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
	// contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical)
	// Feature is a valid filter but not a valid grouping.
	// CONTACTS_TRANSFERRED_OUT_BY_AGENT Unit: Count Valid groupings and filters:
	// Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out by
	// agent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical)
	// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: Count Valid groupings and filters:
	// Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out
	// queue (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical)
	// CURRENT_CASES Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings
	// and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Current cases (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical)
	// MAX_QUEUED_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Maximum queued time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical)
	// PERCENT_CASES_FIRST_CONTACT_RESOLVED Unit: Percent Required filter key:
	// CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI
	// name: Cases resolved on first contact (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical)
	// PERCENT_CONTACTS_STEP_EXPIRED Unit: Percent Valid groupings and filters: Queue,
	// RoutingStepExpression UI name: Not available PERCENT_CONTACTS_STEP_JOINED Unit:
	// Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: Not
	// available PERCENT_NON_TALK_TIME This metric is available only for contacts
	// analyzed by Contact Lens conversational analytics. Unit: Percentage Valid
	// groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Non-talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical)
	// PERCENT_TALK_TIME This metric is available only for contacts analyzed by Contact
	// Lens conversational analytics. Unit: Percentage Valid groupings and filters:
	// Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical)
	// PERCENT_TALK_TIME_AGENT This metric is available only for contacts analyzed by
	// Contact Lens conversational analytics. Unit: Percentage Valid groupings and
	// filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Talk time agent percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical)
	// PERCENT_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed
	// by Contact Lens conversational analytics. Unit: Percentage Valid groupings and
	// filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
	// contact/segmentAttributes/connect:Subtype UI name: Talk time customer percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical)
	// REOPENED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid
	// groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases reopened (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical)
	// RESOLVED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid
	// groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historicall)
	// SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit:
	// Percent Valid groupings and filters: Queue, Channel, Routing Profile Threshold:
	// For ThresholdValue , enter any whole number from 1 to 604800 (inclusive), in
	// seconds. For Comparison , you must enter LT (for "Less than"). UI name: Service
	// level X (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical)
	// STEP_CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue,
	// RoutingStepExpression UI name: Not available SUM_AFTER_CONTACT_WORK_TIME Unit:
	// Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
	// Agent Hierarchy UI name: After contact work time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical)
	// SUM_CONNECTING_TIME_AGENT Unit: Seconds Valid metric filter key:
	// INITIATION_METHOD . This metric only supports the following filter keys as
	// INITIATION_METHOD : INBOUND | OUTBOUND | CALLBACK | API Valid groupings and
	// filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent
	// API connecting time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time)
	// The Negate key in Metric Level Filters is not applicable for this metric.
	// SUM_CONTACT_FLOW_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy UI name: Contact flow time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical)
	// SUM_CONTACT_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue,
	// Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent on contact time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical)
	// SUM_CONTACTS_ANSWERED_IN_X Unit: Count Valid groupings and filters: Queue,
	// Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold:
	// For ThresholdValue , enter any whole number from 1 to 604800 (inclusive), in
	// seconds. For Comparison , you must enter LT (for "Less than"). UI name:
	// Contacts answered in X seconds (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical)
	// SUM_CONTACTS_ABANDONED_IN_X Unit: Count Valid groupings and filters: Queue,
	// Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold:
	// For ThresholdValue , enter any whole number from 1 to 604800 (inclusive), in
	// seconds. For Comparison , you must enter LT (for "Less than"). UI name:
	// Contacts abandoned in X seconds (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical)
	// SUM_CONTACTS_DISCONNECTED Valid metric filter key: DISCONNECT_REASON Unit:
	// Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent
	// Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contact
	// disconnected (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical)
	// SUM_ERROR_STATUS_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue,
	// Channel, Routing Profile, Agent, Agent Hierarchy UI name: Error status time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#error-status-time-historical)
	// SUM_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy UI name: Contact handle time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-handle-time-historical)
	// SUM_HOLD_TIME Unit: Count Valid groupings and filters: Queue, Channel, Routing
	// Profile, Agent, Agent Hierarchy UI name: Customer hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#customer-hold-time-historical)
	// SUM_IDLE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile,
	// Agent, Agent Hierarchy UI name: Agent idle time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-idle-time-historica)
	// SUM_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue,
	// Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction and
	// hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-hold-time-historical)
	// SUM_INTERACTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
	// Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-time-historical)
	// SUM_NON_PRODUCTIVE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing
	// Profile, Agent, Agent Hierarchy UI name: Non-Productive Time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#npt-historical)
	// SUM_ONLINE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing
	// Profile, Agent, Agent Hierarchy UI name: Online time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#online-time-historical)
	// SUM_RETRY_CALLBACK_ATTEMPTS Unit: Count Valid groupings and filters: Queue,
	// Channel, Routing Profile, contact/segmentAttributes/connect:Subtype UI name:
	// Callback attempts (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#callback-attempts-historical)
	//
	// This member is required.
	Metrics []types.MetricV2

	// The Amazon Resource Name (ARN) of the resource. This includes the instanceId an
	// Amazon Connect instance.
	//
	// This member is required.
	ResourceArn *string

	// The timestamp, in UNIX Epoch time format, at which to start the reporting
	// interval for the retrieval of historical metrics data. The time must be before
	// the end time timestamp. The start and end time depends on the IntervalPeriod
	// selected. By default the time range between start and end time is 35 days.
	// Historical metrics are available for 3 months.
	//
	// This member is required.
	StartTime *time.Time

	// The grouping applied to the metrics that are returned. For example, when
	// results are grouped by queue, the metrics returned are grouped by queue. The
	// values that are returned apply to the metrics for each queue. They are not
	// aggregated for all queues. If no grouping is specified, a summary of all metrics
	// is returned. Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL |
	// AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO |
	// AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR |
	// AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS |
	// contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
	Groupings []string

	// The interval period and timezone to apply to returned metrics.
	//   - IntervalPeriod : An aggregated grouping applied to request metrics. Valid
	//   IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK |
	//   TOTAL . For example, if IntervalPeriod is selected THIRTY_MIN , StartTime and
	//   EndTime differs by 1 day, then Amazon Connect returns 48 results in the
	//   response. Each result is aggregated by the THIRTY_MIN period. By default Amazon
	//   Connect aggregates results based on the TOTAL interval period. The following
	//   list describes restrictions on StartTime and EndTime based on which
	//   IntervalPeriod is requested.
	//   - FIFTEEN_MIN : The difference between StartTime and EndTime must be less than
	//   3 days.
	//   - THIRTY_MIN : The difference between StartTime and EndTime must be less than
	//   3 days.
	//   - HOUR : The difference between StartTime and EndTime must be less than 3
	//   days.
	//   - DAY : The difference between StartTime and EndTime must be less than 35
	//   days.
	//   - WEEK : The difference between StartTime and EndTime must be less than 35
	//   days.
	//   - TOTAL : The difference between StartTime and EndTime must be less than 35
	//   days.
	//   - TimeZone : The timezone applied to requested metrics.
	Interval *types.IntervalDetails

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetMetricDataV2Output added in v1.49.0 

type GetMetricDataV2Output struct {

	// Information about the metrics requested in the API request If no grouping is
	// specified, a summary of metric data is returned.
	MetricResults []types.MetricResultV2

	// If there are additional results, this is 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
}

type GetMetricDataV2Paginator added in v1.49.0 

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

GetMetricDataV2Paginator is a paginator for GetMetricDataV2

func NewGetMetricDataV2Paginator added in v1.49.0 

func NewGetMetricDataV2Paginator(client GetMetricDataV2APIClient, params *GetMetricDataV2Input, optFns ...func(*GetMetricDataV2PaginatorOptions)) *GetMetricDataV2Paginator

NewGetMetricDataV2Paginator returns a new GetMetricDataV2Paginator

func (*GetMetricDataV2Paginator) HasMorePages added in v1.49.0 

func (p *GetMetricDataV2Paginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetMetricDataV2Paginator) NextPage added in v1.49.0 

func (p *GetMetricDataV2Paginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetMetricDataV2Output, error)

NextPage retrieves the next GetMetricDataV2 page.

type GetMetricDataV2PaginatorOptions added in v1.49.0 

type GetMetricDataV2PaginatorOptions 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
}

GetMetricDataV2PaginatorOptions is the paginator options for GetMetricDataV2

type GetPromptFileInput added in v1.55.0 

type GetPromptFileInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the prompt.
	//
	// This member is required.
	PromptId *string
	// contains filtered or unexported fields
}

type GetPromptFileOutput added in v1.55.0 

type GetPromptFileOutput struct {

	// The Amazon Web Services Region where this resource was last modified.
	LastModifiedRegion *string

	// The timestamp when this resource was last modified.
	LastModifiedTime *time.Time

	// A generated URL to the prompt that can be given to an unauthorized user so they
	// can access the prompt in S3.
	PromptPresignedUrl *string

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

type GetTaskTemplateInput added in v1.25.0 

type GetTaskTemplateInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the task template.
	//
	// This member is required.
	TaskTemplateId *string

	// The system generated version of a task template that is associated with a task,
	// when the task is created.
	SnapshotVersion *string
	// contains filtered or unexported fields
}

type GetTaskTemplateOutput added in v1.25.0 

type GetTaskTemplateOutput struct {

	// The Amazon Resource Name (ARN).
	//
	// This member is required.
	Arn *string

	// A unique identifier for the task template.
	//
	// This member is required.
	Id *string

	// The name of the task template.
	//
	// This member is required.
	Name *string

	// Constraints that are applicable to the fields listed.
	Constraints *types.TaskTemplateConstraints

	// The identifier of the flow that runs by default when a task is created by
	// referencing this template.
	ContactFlowId *string

	// The timestamp when the task template was created.
	CreatedTime *time.Time

	// The default values for fields when a task is created by referencing this
	// template.
	Defaults *types.TaskTemplateDefaults

	// The description of the task template.
	Description *string

	// Fields that are part of the template.
	Fields []types.TaskTemplateField

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	InstanceId *string

	// The timestamp when the task template was last modified.
	LastModifiedTime *time.Time

	// Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
	// only be created from ACTIVE templates. If a template is marked as INACTIVE ,
	// then a task that refers to this template cannot be created.
	Status types.TaskTemplateStatus

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string

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

type GetTrafficDistributionInput added in v1.33.0 

type GetTrafficDistributionInput struct {

	// The identifier of the traffic distribution group. This can be the ID or the ARN
	// if the API is being called in the Region where the traffic distribution group
	// was created. The ARN must be provided if the call is from the replicated Region.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetTrafficDistributionOutput added in v1.33.0 

type GetTrafficDistributionOutput struct {

	// The distribution of agents between the instance and its replica(s).
	AgentConfig *types.AgentConfig

	// The Amazon Resource Name (ARN) of the traffic distribution group.
	Arn *string

	// The identifier of the traffic distribution group. This can be the ID or the ARN
	// if the API is being called in the Region where the traffic distribution group
	// was created. The ARN must be provided if the call is from the replicated Region.
	Id *string

	// The distribution that determines which Amazon Web Services Regions should be
	// used to sign in agents in to both the instance and its replica(s).
	SignInConfig *types.SignInConfig

	// The distribution of traffic between the instance and its replicas.
	TelephonyConfig *types.TelephonyConfig

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

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 IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ImportPhoneNumberInput added in v1.82.0 

type ImportPhoneNumberInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The claimed phone number ARN being imported from the external service, such as
	// Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the
	// phone number to import from Amazon Pinpoint.
	//
	// This member is required.
	SourcePhoneNumberArn *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// The description of the phone number.
	PhoneNumberDescription *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]string
	// contains filtered or unexported fields
}

type ImportPhoneNumberOutput added in v1.82.0 

type ImportPhoneNumberOutput struct {

	// The Amazon Resource Name (ARN) of the phone number.
	PhoneNumberArn *string

	// A unique identifier for the phone number.
	PhoneNumberId *string

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

type ListAgentStatusesAPIClient added in v1.6.0 

type ListAgentStatusesAPIClient interface {
	ListAgentStatuses(context.Context, *ListAgentStatusesInput, ...func(*Options)) (*ListAgentStatusesOutput, error)
}

ListAgentStatusesAPIClient is a client that implements the ListAgentStatuses operation.

type ListAgentStatusesInput added in v1.6.0 

type ListAgentStatusesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Available agent status types.
	AgentStatusTypes []types.AgentStatusType

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAgentStatusesOutput added in v1.6.0 

type ListAgentStatusesOutput struct {

	// A summary of agent statuses.
	AgentStatusSummaryList []types.AgentStatusSummary

	// If there are additional results, this is 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
}

type ListAgentStatusesPaginator added in v1.6.0 

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

ListAgentStatusesPaginator is a paginator for ListAgentStatuses

func NewListAgentStatusesPaginator added in v1.6.0 

func NewListAgentStatusesPaginator(client ListAgentStatusesAPIClient, params *ListAgentStatusesInput, optFns ...func(*ListAgentStatusesPaginatorOptions)) *ListAgentStatusesPaginator

NewListAgentStatusesPaginator returns a new ListAgentStatusesPaginator

func (*ListAgentStatusesPaginator) HasMorePages added in v1.6.0 

func (p *ListAgentStatusesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAgentStatusesPaginator) NextPage added in v1.6.0 

func (p *ListAgentStatusesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentStatusesOutput, error)

NextPage retrieves the next ListAgentStatuses page.

type ListAgentStatusesPaginatorOptions added in v1.6.0 

type ListAgentStatusesPaginatorOptions 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
}

ListAgentStatusesPaginatorOptions is the paginator options for ListAgentStatuses

type ListAnalyticsDataAssociationsInput added in v1.82.0 

type ListAnalyticsDataAssociationsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the dataset to get the association status.
	DataSetId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAnalyticsDataAssociationsOutput added in v1.82.0 

type ListAnalyticsDataAssociationsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// An array of successful results: DataSetId , TargetAccountId , ResourceShareId ,
	// ResourceShareArn . This is a paginated API, so nextToken is given if there are
	// more results to be returned.
	Results []types.AnalyticsDataAssociationResult

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

type ListApprovedOriginsAPIClient added in v0.30.0 

type ListApprovedOriginsAPIClient interface {
	ListApprovedOrigins(context.Context, *ListApprovedOriginsInput, ...func(*Options)) (*ListApprovedOriginsOutput, error)
}

ListApprovedOriginsAPIClient is a client that implements the ListApprovedOrigins operation.

type ListApprovedOriginsInput added in v0.30.0 

type ListApprovedOriginsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListApprovedOriginsOutput added in v0.30.0 

type ListApprovedOriginsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// The approved origins.
	Origins []string

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

type ListApprovedOriginsPaginator added in v0.30.0 

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

ListApprovedOriginsPaginator is a paginator for ListApprovedOrigins

func NewListApprovedOriginsPaginator added in v0.30.0 

func NewListApprovedOriginsPaginator(client ListApprovedOriginsAPIClient, params *ListApprovedOriginsInput, optFns ...func(*ListApprovedOriginsPaginatorOptions)) *ListApprovedOriginsPaginator

NewListApprovedOriginsPaginator returns a new ListApprovedOriginsPaginator

func (*ListApprovedOriginsPaginator) HasMorePages added in v0.30.0 

func (p *ListApprovedOriginsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApprovedOriginsPaginator) NextPage added in v0.30.0 

func (p *ListApprovedOriginsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApprovedOriginsOutput, error)

NextPage retrieves the next ListApprovedOrigins page.

type ListApprovedOriginsPaginatorOptions added in v0.30.0 

type ListApprovedOriginsPaginatorOptions 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
}

ListApprovedOriginsPaginatorOptions is the paginator options for ListApprovedOrigins

type ListBotsAPIClient added in v1.5.0 

type ListBotsAPIClient interface {
	ListBots(context.Context, *ListBotsInput, ...func(*Options)) (*ListBotsOutput, error)
}

ListBotsAPIClient is a client that implements the ListBots operation.

type ListBotsInput added in v1.5.0 

type ListBotsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The version of Amazon Lex or Amazon Lex V2.
	//
	// This member is required.
	LexVersion types.LexVersion

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBotsOutput added in v1.5.0 

type ListBotsOutput struct {

	// The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2
	// bots associated with the specified instance.
	LexBots []types.LexBotConfig

	// If there are additional results, this is 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
}

type ListBotsPaginator added in v1.5.0 

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

ListBotsPaginator is a paginator for ListBots

func NewListBotsPaginator added in v1.5.0 

func NewListBotsPaginator(client ListBotsAPIClient, params *ListBotsInput, optFns ...func(*ListBotsPaginatorOptions)) *ListBotsPaginator

NewListBotsPaginator returns a new ListBotsPaginator

func (*ListBotsPaginator) HasMorePages added in v1.5.0 

func (p *ListBotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotsPaginator) NextPage added in v1.5.0 

func (p *ListBotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotsOutput, error)

NextPage retrieves the next ListBots page.

type ListBotsPaginatorOptions added in v1.5.0 

type ListBotsPaginatorOptions 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
}

ListBotsPaginatorOptions is the paginator options for ListBots

type ListContactEvaluationsAPIClient added in v1.53.0 

type ListContactEvaluationsAPIClient interface {
	ListContactEvaluations(context.Context, *ListContactEvaluationsInput, ...func(*Options)) (*ListContactEvaluationsOutput, error)
}

ListContactEvaluationsAPIClient is a client that implements the ListContactEvaluations operation.

type ListContactEvaluationsInput added in v1.53.0 

type ListContactEvaluationsInput struct {

	// The identifier of the contact in this instance of Amazon Connect.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results. This is not
	// expected to be set because the value returned in the previous response is always
	// null.
	NextToken *string
	// contains filtered or unexported fields
}

type ListContactEvaluationsOutput added in v1.53.0 

type ListContactEvaluationsOutput struct {

	// Provides details about a list of contact evaluations belonging to an instance.
	//
	// This member is required.
	EvaluationSummaryList []types.EvaluationSummary

	// If there are additional results, this is the token for the next set of results.
	// This is always returned as null in the response.
	NextToken *string

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

type ListContactEvaluationsPaginator added in v1.53.0 

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

ListContactEvaluationsPaginator is a paginator for ListContactEvaluations

func NewListContactEvaluationsPaginator added in v1.53.0 

func NewListContactEvaluationsPaginator(client ListContactEvaluationsAPIClient, params *ListContactEvaluationsInput, optFns ...func(*ListContactEvaluationsPaginatorOptions)) *ListContactEvaluationsPaginator

NewListContactEvaluationsPaginator returns a new ListContactEvaluationsPaginator

func (*ListContactEvaluationsPaginator) HasMorePages added in v1.53.0 

func (p *ListContactEvaluationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactEvaluationsPaginator) NextPage added in v1.53.0 

func (p *ListContactEvaluationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContactEvaluationsOutput, error)

NextPage retrieves the next ListContactEvaluations page.

type ListContactEvaluationsPaginatorOptions added in v1.53.0 

type ListContactEvaluationsPaginatorOptions struct {
	// 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
}

ListContactEvaluationsPaginatorOptions is the paginator options for ListContactEvaluations

type ListContactFlowModulesAPIClient added in v1.13.0 

type ListContactFlowModulesAPIClient interface {
	ListContactFlowModules(context.Context, *ListContactFlowModulesInput, ...func(*Options)) (*ListContactFlowModulesOutput, error)
}

ListContactFlowModulesAPIClient is a client that implements the ListContactFlowModules operation.

type ListContactFlowModulesInput added in v1.13.0 

type ListContactFlowModulesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The state of the flow module.
	ContactFlowModuleState types.ContactFlowModuleState

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListContactFlowModulesOutput added in v1.13.0 

type ListContactFlowModulesOutput struct {

	// Information about the flow module.
	ContactFlowModulesSummaryList []types.ContactFlowModuleSummary

	// If there are additional results, this is 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
}

type ListContactFlowModulesPaginator added in v1.13.0 

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

ListContactFlowModulesPaginator is a paginator for ListContactFlowModules

func NewListContactFlowModulesPaginator added in v1.13.0 

func NewListContactFlowModulesPaginator(client ListContactFlowModulesAPIClient, params *ListContactFlowModulesInput, optFns ...func(*ListContactFlowModulesPaginatorOptions)) *ListContactFlowModulesPaginator

NewListContactFlowModulesPaginator returns a new ListContactFlowModulesPaginator

func (*ListContactFlowModulesPaginator) HasMorePages added in v1.13.0 

func (p *ListContactFlowModulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactFlowModulesPaginator) NextPage added in v1.13.0 

func (p *ListContactFlowModulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContactFlowModulesOutput, error)

NextPage retrieves the next ListContactFlowModules page.

type ListContactFlowModulesPaginatorOptions added in v1.13.0 

type ListContactFlowModulesPaginatorOptions 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
}

ListContactFlowModulesPaginatorOptions is the paginator options for ListContactFlowModules

type ListContactFlowsAPIClient added in v0.30.0 

type ListContactFlowsAPIClient interface {
	ListContactFlows(context.Context, *ListContactFlowsInput, ...func(*Options)) (*ListContactFlowsOutput, error)
}

ListContactFlowsAPIClient is a client that implements the ListContactFlows operation.

type ListContactFlowsInput 

type ListContactFlowsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The type of flow.
	ContactFlowTypes []types.ContactFlowType

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListContactFlowsOutput 

type ListContactFlowsOutput struct {

	// Information about the flows.
	ContactFlowSummaryList []types.ContactFlowSummary

	// If there are additional results, this is 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
}

type ListContactFlowsPaginator added in v0.30.0 

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

ListContactFlowsPaginator is a paginator for ListContactFlows

func NewListContactFlowsPaginator added in v0.30.0 

func NewListContactFlowsPaginator(client ListContactFlowsAPIClient, params *ListContactFlowsInput, optFns ...func(*ListContactFlowsPaginatorOptions)) *ListContactFlowsPaginator

NewListContactFlowsPaginator returns a new ListContactFlowsPaginator

func (*ListContactFlowsPaginator) HasMorePages added in v0.30.0 

func (p *ListContactFlowsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactFlowsPaginator) NextPage added in v0.30.0 

func (p *ListContactFlowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContactFlowsOutput, error)

NextPage retrieves the next ListContactFlows page.

type ListContactFlowsPaginatorOptions added in v0.30.0 

type ListContactFlowsPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListContactFlowsPaginatorOptions is the paginator options for ListContactFlows

type ListContactReferencesAPIClient added in v1.12.0 

type ListContactReferencesAPIClient interface {
	ListContactReferences(context.Context, *ListContactReferencesInput, ...func(*Options)) (*ListContactReferencesOutput, error)
}

ListContactReferencesAPIClient is a client that implements the ListContactReferences operation.

type ListContactReferencesInput added in v1.12.0 

type ListContactReferencesInput struct {

	// The identifier of the initial contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The type of reference.
	//
	// This member is required.
	ReferenceTypes []types.ReferenceType

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results. This is not
	// expected to be set, because the value returned in the previous response is
	// always null.
	NextToken *string
	// contains filtered or unexported fields
}

type ListContactReferencesOutput added in v1.12.0 

type ListContactReferencesOutput struct {

	// If there are additional results, this is the token for the next set of results.
	// This is always returned as null in the response.
	NextToken *string

	// Information about the flows.
	ReferenceSummaryList []types.ReferenceSummary

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

type ListContactReferencesPaginator added in v1.12.0 

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

ListContactReferencesPaginator is a paginator for ListContactReferences

func NewListContactReferencesPaginator added in v1.12.0 

func NewListContactReferencesPaginator(client ListContactReferencesAPIClient, params *ListContactReferencesInput, optFns ...func(*ListContactReferencesPaginatorOptions)) *ListContactReferencesPaginator

NewListContactReferencesPaginator returns a new ListContactReferencesPaginator

func (*ListContactReferencesPaginator) HasMorePages added in v1.12.0 

func (p *ListContactReferencesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactReferencesPaginator) NextPage added in v1.12.0 

func (p *ListContactReferencesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContactReferencesOutput, error)

NextPage retrieves the next ListContactReferences page.

type ListContactReferencesPaginatorOptions added in v1.12.0 

type ListContactReferencesPaginatorOptions struct {
	// 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
}

ListContactReferencesPaginatorOptions is the paginator options for ListContactReferences

type ListDefaultVocabulariesAPIClient added in v1.17.0 

type ListDefaultVocabulariesAPIClient interface {
	ListDefaultVocabularies(context.Context, *ListDefaultVocabulariesInput, ...func(*Options)) (*ListDefaultVocabulariesOutput, error)
}

ListDefaultVocabulariesAPIClient is a client that implements the ListDefaultVocabularies operation.

type ListDefaultVocabulariesInput added in v1.17.0 

type ListDefaultVocabulariesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The language code of the vocabulary entries. For a list of languages and their
	// corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)
	LanguageCode types.VocabularyLanguageCode

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDefaultVocabulariesOutput added in v1.17.0 

type ListDefaultVocabulariesOutput struct {

	// A list of default vocabularies.
	//
	// This member is required.
	DefaultVocabularyList []types.DefaultVocabulary

	// If there are additional results, this is 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
}

type ListDefaultVocabulariesPaginator added in v1.17.0 

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

ListDefaultVocabulariesPaginator is a paginator for ListDefaultVocabularies

func NewListDefaultVocabulariesPaginator added in v1.17.0 

func NewListDefaultVocabulariesPaginator(client ListDefaultVocabulariesAPIClient, params *ListDefaultVocabulariesInput, optFns ...func(*ListDefaultVocabulariesPaginatorOptions)) *ListDefaultVocabulariesPaginator

NewListDefaultVocabulariesPaginator returns a new ListDefaultVocabulariesPaginator

func (*ListDefaultVocabulariesPaginator) HasMorePages added in v1.17.0 

func (p *ListDefaultVocabulariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDefaultVocabulariesPaginator) NextPage added in v1.17.0 

func (p *ListDefaultVocabulariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDefaultVocabulariesOutput, error)

NextPage retrieves the next ListDefaultVocabularies page.

type ListDefaultVocabulariesPaginatorOptions added in v1.17.0 

type ListDefaultVocabulariesPaginatorOptions 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
}

ListDefaultVocabulariesPaginatorOptions is the paginator options for ListDefaultVocabularies

type ListEvaluationFormVersionsAPIClient added in v1.53.0 

type ListEvaluationFormVersionsAPIClient interface {
	ListEvaluationFormVersions(context.Context, *ListEvaluationFormVersionsInput, ...func(*Options)) (*ListEvaluationFormVersionsOutput, error)
}

ListEvaluationFormVersionsAPIClient is a client that implements the ListEvaluationFormVersions operation.

type ListEvaluationFormVersionsInput added in v1.53.0 

type ListEvaluationFormVersionsInput struct {

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEvaluationFormVersionsOutput added in v1.53.0 

type ListEvaluationFormVersionsOutput struct {

	// Provides details about a list of evaluation forms belonging to an instance.
	//
	// This member is required.
	EvaluationFormVersionSummaryList []types.EvaluationFormVersionSummary

	// If there are additional results, this is 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
}

type ListEvaluationFormVersionsPaginator added in v1.53.0 

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

ListEvaluationFormVersionsPaginator is a paginator for ListEvaluationFormVersions

func NewListEvaluationFormVersionsPaginator added in v1.53.0 

func NewListEvaluationFormVersionsPaginator(client ListEvaluationFormVersionsAPIClient, params *ListEvaluationFormVersionsInput, optFns ...func(*ListEvaluationFormVersionsPaginatorOptions)) *ListEvaluationFormVersionsPaginator

NewListEvaluationFormVersionsPaginator returns a new ListEvaluationFormVersionsPaginator

func (*ListEvaluationFormVersionsPaginator) HasMorePages added in v1.53.0 

func (p *ListEvaluationFormVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEvaluationFormVersionsPaginator) NextPage added in v1.53.0 

func (p *ListEvaluationFormVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEvaluationFormVersionsOutput, error)

NextPage retrieves the next ListEvaluationFormVersions page.

type ListEvaluationFormVersionsPaginatorOptions added in v1.53.0 

type ListEvaluationFormVersionsPaginatorOptions 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
}

ListEvaluationFormVersionsPaginatorOptions is the paginator options for ListEvaluationFormVersions

type ListEvaluationFormsAPIClient added in v1.53.0 

type ListEvaluationFormsAPIClient interface {
	ListEvaluationForms(context.Context, *ListEvaluationFormsInput, ...func(*Options)) (*ListEvaluationFormsOutput, error)
}

ListEvaluationFormsAPIClient is a client that implements the ListEvaluationForms operation.

type ListEvaluationFormsInput added in v1.53.0 

type ListEvaluationFormsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEvaluationFormsOutput added in v1.53.0 

type ListEvaluationFormsOutput struct {

	// Provides details about a list of evaluation forms belonging to an instance.
	//
	// This member is required.
	EvaluationFormSummaryList []types.EvaluationFormSummary

	// If there are additional results, this is 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
}

type ListEvaluationFormsPaginator added in v1.53.0 

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

ListEvaluationFormsPaginator is a paginator for ListEvaluationForms

func NewListEvaluationFormsPaginator added in v1.53.0 

func NewListEvaluationFormsPaginator(client ListEvaluationFormsAPIClient, params *ListEvaluationFormsInput, optFns ...func(*ListEvaluationFormsPaginatorOptions)) *ListEvaluationFormsPaginator

NewListEvaluationFormsPaginator returns a new ListEvaluationFormsPaginator

func (*ListEvaluationFormsPaginator) HasMorePages added in v1.53.0 

func (p *ListEvaluationFormsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEvaluationFormsPaginator) NextPage added in v1.53.0 

func (p *ListEvaluationFormsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEvaluationFormsOutput, error)

NextPage retrieves the next ListEvaluationForms page.

type ListEvaluationFormsPaginatorOptions added in v1.53.0 

type ListEvaluationFormsPaginatorOptions 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
}

ListEvaluationFormsPaginatorOptions is the paginator options for ListEvaluationForms

type ListFlowAssociationsAPIClient added in v1.82.0 

type ListFlowAssociationsAPIClient interface {
	ListFlowAssociations(context.Context, *ListFlowAssociationsInput, ...func(*Options)) (*ListFlowAssociationsOutput, error)
}

ListFlowAssociationsAPIClient is a client that implements the ListFlowAssociations operation.

type ListFlowAssociationsInput added in v1.82.0 

type ListFlowAssociationsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// A valid resource type.
	ResourceType types.ListFlowAssociationResourceType
	// contains filtered or unexported fields
}

type ListFlowAssociationsOutput added in v1.82.0 

type ListFlowAssociationsOutput struct {

	// Summary of flow associations.
	FlowAssociationSummaryList []types.FlowAssociationSummary

	// If there are additional results, this is 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
}

type ListFlowAssociationsPaginator added in v1.82.0 

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

ListFlowAssociationsPaginator is a paginator for ListFlowAssociations

func NewListFlowAssociationsPaginator added in v1.82.0 

func NewListFlowAssociationsPaginator(client ListFlowAssociationsAPIClient, params *ListFlowAssociationsInput, optFns ...func(*ListFlowAssociationsPaginatorOptions)) *ListFlowAssociationsPaginator

NewListFlowAssociationsPaginator returns a new ListFlowAssociationsPaginator

func (*ListFlowAssociationsPaginator) HasMorePages added in v1.82.0 

func (p *ListFlowAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFlowAssociationsPaginator) NextPage added in v1.82.0 

func (p *ListFlowAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFlowAssociationsOutput, error)

NextPage retrieves the next ListFlowAssociations page.

type ListFlowAssociationsPaginatorOptions added in v1.82.0 

type ListFlowAssociationsPaginatorOptions 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
}

ListFlowAssociationsPaginatorOptions is the paginator options for ListFlowAssociations

type ListHoursOfOperationsAPIClient added in v0.30.0 

type ListHoursOfOperationsAPIClient interface {
	ListHoursOfOperations(context.Context, *ListHoursOfOperationsInput, ...func(*Options)) (*ListHoursOfOperationsOutput, error)
}

ListHoursOfOperationsAPIClient is a client that implements the ListHoursOfOperations operation.

type ListHoursOfOperationsInput 

type ListHoursOfOperationsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListHoursOfOperationsOutput 

type ListHoursOfOperationsOutput struct {

	// Information about the hours of operation.
	HoursOfOperationSummaryList []types.HoursOfOperationSummary

	// If there are additional results, this is 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
}

type ListHoursOfOperationsPaginator added in v0.30.0 

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

ListHoursOfOperationsPaginator is a paginator for ListHoursOfOperations

func NewListHoursOfOperationsPaginator added in v0.30.0 

func NewListHoursOfOperationsPaginator(client ListHoursOfOperationsAPIClient, params *ListHoursOfOperationsInput, optFns ...func(*ListHoursOfOperationsPaginatorOptions)) *ListHoursOfOperationsPaginator

NewListHoursOfOperationsPaginator returns a new ListHoursOfOperationsPaginator

func (*ListHoursOfOperationsPaginator) HasMorePages added in v0.30.0 

func (p *ListHoursOfOperationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListHoursOfOperationsPaginator) NextPage added in v0.30.0 

func (p *ListHoursOfOperationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListHoursOfOperationsOutput, error)

NextPage retrieves the next ListHoursOfOperations page.

type ListHoursOfOperationsPaginatorOptions added in v0.30.0 

type ListHoursOfOperationsPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListHoursOfOperationsPaginatorOptions is the paginator options for ListHoursOfOperations

type ListInstanceAttributesAPIClient added in v0.30.0 

type ListInstanceAttributesAPIClient interface {
	ListInstanceAttributes(context.Context, *ListInstanceAttributesInput, ...func(*Options)) (*ListInstanceAttributesOutput, error)
}

ListInstanceAttributesAPIClient is a client that implements the ListInstanceAttributes operation.

type ListInstanceAttributesInput added in v0.30.0 

type ListInstanceAttributesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListInstanceAttributesOutput added in v0.30.0 

type ListInstanceAttributesOutput struct {

	// The attribute types.
	Attributes []types.Attribute

	// If there are additional results, this is 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
}

type ListInstanceAttributesPaginator added in v0.30.0 

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

ListInstanceAttributesPaginator is a paginator for ListInstanceAttributes

func NewListInstanceAttributesPaginator added in v0.30.0 

func NewListInstanceAttributesPaginator(client ListInstanceAttributesAPIClient, params *ListInstanceAttributesInput, optFns ...func(*ListInstanceAttributesPaginatorOptions)) *ListInstanceAttributesPaginator

NewListInstanceAttributesPaginator returns a new ListInstanceAttributesPaginator

func (*ListInstanceAttributesPaginator) HasMorePages added in v0.30.0 

func (p *ListInstanceAttributesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstanceAttributesPaginator) NextPage added in v0.30.0 

func (p *ListInstanceAttributesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstanceAttributesOutput, error)

NextPage retrieves the next ListInstanceAttributes page.

type ListInstanceAttributesPaginatorOptions added in v0.30.0 

type ListInstanceAttributesPaginatorOptions 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
}

ListInstanceAttributesPaginatorOptions is the paginator options for ListInstanceAttributes

type ListInstanceStorageConfigsAPIClient added in v0.30.0 

type ListInstanceStorageConfigsAPIClient interface {
	ListInstanceStorageConfigs(context.Context, *ListInstanceStorageConfigsInput, ...func(*Options)) (*ListInstanceStorageConfigsOutput, error)
}

ListInstanceStorageConfigsAPIClient is a client that implements the ListInstanceStorageConfigs operation.

type ListInstanceStorageConfigsInput added in v0.30.0 

type ListInstanceStorageConfigsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A valid resource type.
	//
	// This member is required.
	ResourceType types.InstanceStorageResourceType

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListInstanceStorageConfigsOutput added in v0.30.0 

type ListInstanceStorageConfigsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// A valid storage type.
	StorageConfigs []types.InstanceStorageConfig

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

type ListInstanceStorageConfigsPaginator added in v0.30.0 

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

ListInstanceStorageConfigsPaginator is a paginator for ListInstanceStorageConfigs

func NewListInstanceStorageConfigsPaginator added in v0.30.0 

func NewListInstanceStorageConfigsPaginator(client ListInstanceStorageConfigsAPIClient, params *ListInstanceStorageConfigsInput, optFns ...func(*ListInstanceStorageConfigsPaginatorOptions)) *ListInstanceStorageConfigsPaginator

NewListInstanceStorageConfigsPaginator returns a new ListInstanceStorageConfigsPaginator

func (*ListInstanceStorageConfigsPaginator) HasMorePages added in v0.30.0 

func (p *ListInstanceStorageConfigsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstanceStorageConfigsPaginator) NextPage added in v0.30.0 

func (p *ListInstanceStorageConfigsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstanceStorageConfigsOutput, error)

NextPage retrieves the next ListInstanceStorageConfigs page.

type ListInstanceStorageConfigsPaginatorOptions added in v0.30.0 

type ListInstanceStorageConfigsPaginatorOptions 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
}

ListInstanceStorageConfigsPaginatorOptions is the paginator options for ListInstanceStorageConfigs

type ListInstancesAPIClient added in v0.30.0 

type ListInstancesAPIClient interface {
	ListInstances(context.Context, *ListInstancesInput, ...func(*Options)) (*ListInstancesOutput, error)
}

ListInstancesAPIClient is a client that implements the ListInstances operation.

type ListInstancesInput added in v0.30.0 

type ListInstancesInput struct {

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListInstancesOutput added in v0.30.0 

type ListInstancesOutput struct {

	// Information about the instances.
	InstanceSummaryList []types.InstanceSummary

	// If there are additional results, this is 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
}

type ListInstancesPaginator added in v0.30.0 

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

ListInstancesPaginator is a paginator for ListInstances

func NewListInstancesPaginator added in v0.30.0 

func NewListInstancesPaginator(client ListInstancesAPIClient, params *ListInstancesInput, optFns ...func(*ListInstancesPaginatorOptions)) *ListInstancesPaginator

NewListInstancesPaginator returns a new ListInstancesPaginator

func (*ListInstancesPaginator) HasMorePages added in v0.30.0 

func (p *ListInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstancesPaginator) NextPage added in v0.30.0 

func (p *ListInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstancesOutput, error)

NextPage retrieves the next ListInstances page.

type ListInstancesPaginatorOptions added in v0.30.0 

type ListInstancesPaginatorOptions 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
}

ListInstancesPaginatorOptions is the paginator options for ListInstances

type ListIntegrationAssociationsAPIClient added in v0.31.0 

type ListIntegrationAssociationsAPIClient interface {
	ListIntegrationAssociations(context.Context, *ListIntegrationAssociationsInput, ...func(*Options)) (*ListIntegrationAssociationsOutput, error)
}

ListIntegrationAssociationsAPIClient is a client that implements the ListIntegrationAssociations operation.

type ListIntegrationAssociationsInput added in v0.31.0 

type ListIntegrationAssociationsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The Amazon Resource Name (ARN) of the integration.
	IntegrationArn *string

	// The integration type.
	IntegrationType types.IntegrationType

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIntegrationAssociationsOutput added in v0.31.0 

type ListIntegrationAssociationsOutput struct {

	// The associations.
	IntegrationAssociationSummaryList []types.IntegrationAssociationSummary

	// If there are additional results, this is 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
}

type ListIntegrationAssociationsPaginator added in v0.31.0 

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

ListIntegrationAssociationsPaginator is a paginator for ListIntegrationAssociations

func NewListIntegrationAssociationsPaginator added in v0.31.0 

func NewListIntegrationAssociationsPaginator(client ListIntegrationAssociationsAPIClient, params *ListIntegrationAssociationsInput, optFns ...func(*ListIntegrationAssociationsPaginatorOptions)) *ListIntegrationAssociationsPaginator

NewListIntegrationAssociationsPaginator returns a new ListIntegrationAssociationsPaginator

func (*ListIntegrationAssociationsPaginator) HasMorePages added in v0.31.0 

func (p *ListIntegrationAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIntegrationAssociationsPaginator) NextPage added in v0.31.0 

func (p *ListIntegrationAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIntegrationAssociationsOutput, error)

NextPage retrieves the next ListIntegrationAssociations page.

type ListIntegrationAssociationsPaginatorOptions added in v0.31.0 

type ListIntegrationAssociationsPaginatorOptions 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
}

ListIntegrationAssociationsPaginatorOptions is the paginator options for ListIntegrationAssociations

type ListLambdaFunctionsAPIClient added in v0.30.0 

type ListLambdaFunctionsAPIClient interface {
	ListLambdaFunctions(context.Context, *ListLambdaFunctionsInput, ...func(*Options)) (*ListLambdaFunctionsOutput, error)
}

ListLambdaFunctionsAPIClient is a client that implements the ListLambdaFunctions operation.

type ListLambdaFunctionsInput added in v0.30.0 

type ListLambdaFunctionsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLambdaFunctionsOutput added in v0.30.0 

type ListLambdaFunctionsOutput struct {

	// The Lambdafunction ARNs associated with the specified instance.
	LambdaFunctions []string

	// If there are additional results, this is 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
}

type ListLambdaFunctionsPaginator added in v0.30.0 

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

ListLambdaFunctionsPaginator is a paginator for ListLambdaFunctions

func NewListLambdaFunctionsPaginator added in v0.30.0 

func NewListLambdaFunctionsPaginator(client ListLambdaFunctionsAPIClient, params *ListLambdaFunctionsInput, optFns ...func(*ListLambdaFunctionsPaginatorOptions)) *ListLambdaFunctionsPaginator

NewListLambdaFunctionsPaginator returns a new ListLambdaFunctionsPaginator

func (*ListLambdaFunctionsPaginator) HasMorePages added in v0.30.0 

func (p *ListLambdaFunctionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLambdaFunctionsPaginator) NextPage added in v0.30.0 

func (p *ListLambdaFunctionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLambdaFunctionsOutput, error)

NextPage retrieves the next ListLambdaFunctions page.

type ListLambdaFunctionsPaginatorOptions added in v0.30.0 

type ListLambdaFunctionsPaginatorOptions 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
}

ListLambdaFunctionsPaginatorOptions is the paginator options for ListLambdaFunctions

type ListLexBotsAPIClient added in v0.30.0 

type ListLexBotsAPIClient interface {
	ListLexBots(context.Context, *ListLexBotsInput, ...func(*Options)) (*ListLexBotsOutput, error)
}

ListLexBotsAPIClient is a client that implements the ListLexBots operation.

type ListLexBotsInput added in v0.30.0 

type ListLexBotsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. If no value is specified, the
	// default is 10.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLexBotsOutput added in v0.30.0 

type ListLexBotsOutput struct {

	// The names and Amazon Web Services Regions of the Amazon Lex bots associated
	// with the specified instance.
	LexBots []types.LexBot

	// If there are additional results, this is 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
}

type ListLexBotsPaginator added in v0.30.0 

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

ListLexBotsPaginator is a paginator for ListLexBots

func NewListLexBotsPaginator added in v0.30.0 

func NewListLexBotsPaginator(client ListLexBotsAPIClient, params *ListLexBotsInput, optFns ...func(*ListLexBotsPaginatorOptions)) *ListLexBotsPaginator

NewListLexBotsPaginator returns a new ListLexBotsPaginator

func (*ListLexBotsPaginator) HasMorePages added in v0.30.0 

func (p *ListLexBotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLexBotsPaginator) NextPage added in v0.30.0 

func (p *ListLexBotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLexBotsOutput, error)

NextPage retrieves the next ListLexBots page.

type ListLexBotsPaginatorOptions added in v0.30.0 

type ListLexBotsPaginatorOptions struct {
	// The maximum number of results to return per page. If no value is specified, the
	// default is 10.
	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
}

ListLexBotsPaginatorOptions is the paginator options for ListLexBots

type ListPhoneNumbersAPIClient added in v0.30.0 

type ListPhoneNumbersAPIClient interface {
	ListPhoneNumbers(context.Context, *ListPhoneNumbersInput, ...func(*Options)) (*ListPhoneNumbersOutput, error)
}

ListPhoneNumbersAPIClient is a client that implements the ListPhoneNumbers operation.

type ListPhoneNumbersInput 

type ListPhoneNumbersInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The ISO country code.
	PhoneNumberCountryCodes []types.PhoneNumberCountryCode

	// The type of phone number. We recommend using ListPhoneNumbersV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html)
	// to return phone number types. While ListPhoneNumbers returns number types UIFN ,
	// SHARED , THIRD_PARTY_TF , and THIRD_PARTY_DID , it incorrectly lists them as
	// TOLL_FREE or DID .
	PhoneNumberTypes []types.PhoneNumberType
	// contains filtered or unexported fields
}

type ListPhoneNumbersOutput 

type ListPhoneNumbersOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the phone numbers.
	PhoneNumberSummaryList []types.PhoneNumberSummary

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

type ListPhoneNumbersPaginator added in v0.30.0 

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

ListPhoneNumbersPaginator is a paginator for ListPhoneNumbers

func NewListPhoneNumbersPaginator added in v0.30.0 

func NewListPhoneNumbersPaginator(client ListPhoneNumbersAPIClient, params *ListPhoneNumbersInput, optFns ...func(*ListPhoneNumbersPaginatorOptions)) *ListPhoneNumbersPaginator

NewListPhoneNumbersPaginator returns a new ListPhoneNumbersPaginator

func (*ListPhoneNumbersPaginator) HasMorePages added in v0.30.0 

func (p *ListPhoneNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPhoneNumbersPaginator) NextPage added in v0.30.0 

func (p *ListPhoneNumbersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPhoneNumbersOutput, error)

NextPage retrieves the next ListPhoneNumbers page.

type ListPhoneNumbersPaginatorOptions added in v0.30.0 

type ListPhoneNumbersPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListPhoneNumbersPaginatorOptions is the paginator options for ListPhoneNumbers

type ListPhoneNumbersV2APIClient added in v1.22.0 

type ListPhoneNumbersV2APIClient interface {
	ListPhoneNumbersV2(context.Context, *ListPhoneNumbersV2Input, ...func(*Options)) (*ListPhoneNumbersV2Output, error)
}

ListPhoneNumbersV2APIClient is a client that implements the ListPhoneNumbersV2 operation.

type ListPhoneNumbersV2Input added in v1.22.0 

type ListPhoneNumbersV2Input struct {

	// The identifier of the Amazon Connect instance that phone numbers are claimed
	// to. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance. If both TargetArn and
	// InstanceId are not provided, this API lists numbers claimed to all the Amazon
	// Connect instances belonging to your account in the same AWS Region as the
	// request.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The ISO country code.
	PhoneNumberCountryCodes []types.PhoneNumberCountryCode

	// The prefix of the phone number. If provided, it must contain + as part of the
	// country code.
	PhoneNumberPrefix *string

	// The type of phone number.
	PhoneNumberTypes []types.PhoneNumberType

	// The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
	// distribution groups that phone number inbound traffic is routed through. If both
	// TargetArn and InstanceId input are not provided, this API lists numbers claimed
	// to all the Amazon Connect instances belonging to your account in the same Amazon
	// Web Services Region as the request.
	TargetArn *string
	// contains filtered or unexported fields
}

type ListPhoneNumbersV2Output added in v1.22.0 

type ListPhoneNumbersV2Output struct {

	// Information about phone numbers that have been claimed to your Amazon Connect
	// instances or traffic distribution groups.
	ListPhoneNumbersSummaryList []types.ListPhoneNumbersSummary

	// If there are additional results, this is 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
}

type ListPhoneNumbersV2Paginator added in v1.22.0 

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

ListPhoneNumbersV2Paginator is a paginator for ListPhoneNumbersV2

func NewListPhoneNumbersV2Paginator added in v1.22.0 

func NewListPhoneNumbersV2Paginator(client ListPhoneNumbersV2APIClient, params *ListPhoneNumbersV2Input, optFns ...func(*ListPhoneNumbersV2PaginatorOptions)) *ListPhoneNumbersV2Paginator

NewListPhoneNumbersV2Paginator returns a new ListPhoneNumbersV2Paginator

func (*ListPhoneNumbersV2Paginator) HasMorePages added in v1.22.0 

func (p *ListPhoneNumbersV2Paginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPhoneNumbersV2Paginator) NextPage added in v1.22.0 

func (p *ListPhoneNumbersV2Paginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPhoneNumbersV2Output, error)

NextPage retrieves the next ListPhoneNumbersV2 page.

type ListPhoneNumbersV2PaginatorOptions added in v1.22.0 

type ListPhoneNumbersV2PaginatorOptions 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
}

ListPhoneNumbersV2PaginatorOptions is the paginator options for ListPhoneNumbersV2

type ListPredefinedAttributesAPIClient added in v1.87.0 

type ListPredefinedAttributesAPIClient interface {
	ListPredefinedAttributes(context.Context, *ListPredefinedAttributesInput, ...func(*Options)) (*ListPredefinedAttributesOutput, error)
}

ListPredefinedAttributesAPIClient is a client that implements the ListPredefinedAttributes operation.

type ListPredefinedAttributesInput added in v1.87.0 

type ListPredefinedAttributesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPredefinedAttributesOutput added in v1.87.0 

type ListPredefinedAttributesOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Summary of the predefined attributes.
	PredefinedAttributeSummaryList []types.PredefinedAttributeSummary

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

type ListPredefinedAttributesPaginator added in v1.87.0 

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

ListPredefinedAttributesPaginator is a paginator for ListPredefinedAttributes

func NewListPredefinedAttributesPaginator added in v1.87.0 

func NewListPredefinedAttributesPaginator(client ListPredefinedAttributesAPIClient, params *ListPredefinedAttributesInput, optFns ...func(*ListPredefinedAttributesPaginatorOptions)) *ListPredefinedAttributesPaginator

NewListPredefinedAttributesPaginator returns a new ListPredefinedAttributesPaginator

func (*ListPredefinedAttributesPaginator) HasMorePages added in v1.87.0 

func (p *ListPredefinedAttributesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPredefinedAttributesPaginator) NextPage added in v1.87.0 

func (p *ListPredefinedAttributesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPredefinedAttributesOutput, error)

NextPage retrieves the next ListPredefinedAttributes page.

type ListPredefinedAttributesPaginatorOptions added in v1.87.0 

type ListPredefinedAttributesPaginatorOptions 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
}

ListPredefinedAttributesPaginatorOptions is the paginator options for ListPredefinedAttributes

type ListPromptsAPIClient added in v0.30.0 

type ListPromptsAPIClient interface {
	ListPrompts(context.Context, *ListPromptsInput, ...func(*Options)) (*ListPromptsOutput, error)
}

ListPromptsAPIClient is a client that implements the ListPrompts operation.

type ListPromptsInput added in v0.29.0 

type ListPromptsInput struct {

	// The identifier of the Amazon Connect instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPromptsOutput added in v0.29.0 

type ListPromptsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the prompts.
	PromptSummaryList []types.PromptSummary

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

type ListPromptsPaginator added in v0.30.0 

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

ListPromptsPaginator is a paginator for ListPrompts

func NewListPromptsPaginator added in v0.30.0 

func NewListPromptsPaginator(client ListPromptsAPIClient, params *ListPromptsInput, optFns ...func(*ListPromptsPaginatorOptions)) *ListPromptsPaginator

NewListPromptsPaginator returns a new ListPromptsPaginator

func (*ListPromptsPaginator) HasMorePages added in v0.30.0 

func (p *ListPromptsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPromptsPaginator) NextPage added in v0.30.0 

func (p *ListPromptsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPromptsOutput, error)

NextPage retrieves the next ListPrompts page.

type ListPromptsPaginatorOptions added in v0.30.0 

type ListPromptsPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListPromptsPaginatorOptions is the paginator options for ListPrompts

type ListQueueQuickConnectsAPIClient added in v1.2.0 

type ListQueueQuickConnectsAPIClient interface {
	ListQueueQuickConnects(context.Context, *ListQueueQuickConnectsInput, ...func(*Options)) (*ListQueueQuickConnectsOutput, error)
}

ListQueueQuickConnectsAPIClient is a client that implements the ListQueueQuickConnects operation.

type ListQueueQuickConnectsInput added in v1.2.0 

type ListQueueQuickConnectsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListQueueQuickConnectsOutput added in v1.2.0 

type ListQueueQuickConnectsOutput struct {

	// The Amazon Web Services Region where this resource was last modified.
	LastModifiedRegion *string

	// The timestamp when this resource was last modified.
	LastModifiedTime *time.Time

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the quick connects.
	QuickConnectSummaryList []types.QuickConnectSummary

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

type ListQueueQuickConnectsPaginator added in v1.2.0 

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

ListQueueQuickConnectsPaginator is a paginator for ListQueueQuickConnects

func NewListQueueQuickConnectsPaginator added in v1.2.0 

func NewListQueueQuickConnectsPaginator(client ListQueueQuickConnectsAPIClient, params *ListQueueQuickConnectsInput, optFns ...func(*ListQueueQuickConnectsPaginatorOptions)) *ListQueueQuickConnectsPaginator

NewListQueueQuickConnectsPaginator returns a new ListQueueQuickConnectsPaginator

func (*ListQueueQuickConnectsPaginator) HasMorePages added in v1.2.0 

func (p *ListQueueQuickConnectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueueQuickConnectsPaginator) NextPage added in v1.2.0 

func (p *ListQueueQuickConnectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueueQuickConnectsOutput, error)

NextPage retrieves the next ListQueueQuickConnects page.

type ListQueueQuickConnectsPaginatorOptions added in v1.2.0 

type ListQueueQuickConnectsPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListQueueQuickConnectsPaginatorOptions is the paginator options for ListQueueQuickConnects

type ListQueuesAPIClient added in v0.30.0 

type ListQueuesAPIClient interface {
	ListQueues(context.Context, *ListQueuesInput, ...func(*Options)) (*ListQueuesOutput, error)
}

ListQueuesAPIClient is a client that implements the ListQueues operation.

type ListQueuesInput 

type ListQueuesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The type of queue.
	QueueTypes []types.QueueType
	// contains filtered or unexported fields
}

type ListQueuesOutput 

type ListQueuesOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the queues.
	QueueSummaryList []types.QueueSummary

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

type ListQueuesPaginator added in v0.30.0 

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

ListQueuesPaginator is a paginator for ListQueues

func NewListQueuesPaginator added in v0.30.0 

func NewListQueuesPaginator(client ListQueuesAPIClient, params *ListQueuesInput, optFns ...func(*ListQueuesPaginatorOptions)) *ListQueuesPaginator

NewListQueuesPaginator returns a new ListQueuesPaginator

func (*ListQueuesPaginator) HasMorePages added in v0.30.0 

func (p *ListQueuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueuesPaginator) NextPage added in v0.30.0 

func (p *ListQueuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueuesOutput, error)

NextPage retrieves the next ListQueues page.

type ListQueuesPaginatorOptions added in v0.30.0 

type ListQueuesPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListQueuesPaginatorOptions is the paginator options for ListQueues

type ListQuickConnectsAPIClient added in v0.31.0 

type ListQuickConnectsAPIClient interface {
	ListQuickConnects(context.Context, *ListQuickConnectsInput, ...func(*Options)) (*ListQuickConnectsOutput, error)
}

ListQuickConnectsAPIClient is a client that implements the ListQuickConnects operation.

type ListQuickConnectsInput added in v0.31.0 

type ListQuickConnectsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The type of quick connect. In the Amazon Connect admin website, when you create
	// a quick connect, you are prompted to assign one of the following types: Agent
	// (USER), External (PHONE_NUMBER), or Queue (QUEUE).
	QuickConnectTypes []types.QuickConnectType
	// contains filtered or unexported fields
}

type ListQuickConnectsOutput added in v0.31.0 

type ListQuickConnectsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the quick connects.
	QuickConnectSummaryList []types.QuickConnectSummary

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

type ListQuickConnectsPaginator added in v0.31.0 

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

ListQuickConnectsPaginator is a paginator for ListQuickConnects

func NewListQuickConnectsPaginator added in v0.31.0 

func NewListQuickConnectsPaginator(client ListQuickConnectsAPIClient, params *ListQuickConnectsInput, optFns ...func(*ListQuickConnectsPaginatorOptions)) *ListQuickConnectsPaginator

NewListQuickConnectsPaginator returns a new ListQuickConnectsPaginator

func (*ListQuickConnectsPaginator) HasMorePages added in v0.31.0 

func (p *ListQuickConnectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQuickConnectsPaginator) NextPage added in v0.31.0 

func (p *ListQuickConnectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQuickConnectsOutput, error)

NextPage retrieves the next ListQuickConnects page.

type ListQuickConnectsPaginatorOptions added in v0.31.0 

type ListQuickConnectsPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListQuickConnectsPaginatorOptions is the paginator options for ListQuickConnects

type ListRealtimeContactAnalysisSegmentsV2APIClient added in v1.82.0 

type ListRealtimeContactAnalysisSegmentsV2APIClient interface {
	ListRealtimeContactAnalysisSegmentsV2(context.Context, *ListRealtimeContactAnalysisSegmentsV2Input, ...func(*Options)) (*ListRealtimeContactAnalysisSegmentsV2Output, error)
}

ListRealtimeContactAnalysisSegmentsV2APIClient is a client that implements the ListRealtimeContactAnalysisSegmentsV2 operation.

type ListRealtimeContactAnalysisSegmentsV2Input added in v1.82.0 

type ListRealtimeContactAnalysisSegmentsV2Input struct {

	// The identifier of the contact in this instance of Amazon Connect.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The Contact Lens output type to be returned.
	//
	// This member is required.
	OutputType types.RealTimeContactAnalysisOutputType

	// Enum with segment types . Each value corresponds to a segment type returned in
	// the segments list of the API. Each segment type has its own structure. Different
	// channels may have different sets of supported segment types.
	//
	// This member is required.
	SegmentTypes []types.RealTimeContactAnalysisSegmentType

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRealtimeContactAnalysisSegmentsV2Output added in v1.82.0 

type ListRealtimeContactAnalysisSegmentsV2Output struct {

	// The channel of the contact. Voice will not be returned.
	//
	// This member is required.
	Channel types.RealTimeContactAnalysisSupportedChannel

	// An analyzed transcript or category.
	//
	// This member is required.
	Segments []types.RealtimeContactAnalysisSegment

	// Status of real-time contact analysis.
	//
	// This member is required.
	Status types.RealTimeContactAnalysisStatus

	// If there are additional results, this is 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
}

type ListRealtimeContactAnalysisSegmentsV2Paginator added in v1.82.0 

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

ListRealtimeContactAnalysisSegmentsV2Paginator is a paginator for ListRealtimeContactAnalysisSegmentsV2

func NewListRealtimeContactAnalysisSegmentsV2Paginator added in v1.82.0 

func NewListRealtimeContactAnalysisSegmentsV2Paginator(client ListRealtimeContactAnalysisSegmentsV2APIClient, params *ListRealtimeContactAnalysisSegmentsV2Input, optFns ...func(*ListRealtimeContactAnalysisSegmentsV2PaginatorOptions)) *ListRealtimeContactAnalysisSegmentsV2Paginator

NewListRealtimeContactAnalysisSegmentsV2Paginator returns a new ListRealtimeContactAnalysisSegmentsV2Paginator

func (*ListRealtimeContactAnalysisSegmentsV2Paginator) HasMorePages added in v1.82.0 

func (p *ListRealtimeContactAnalysisSegmentsV2Paginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRealtimeContactAnalysisSegmentsV2Paginator) NextPage added in v1.82.0 

func (p *ListRealtimeContactAnalysisSegmentsV2Paginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRealtimeContactAnalysisSegmentsV2Output, error)

NextPage retrieves the next ListRealtimeContactAnalysisSegmentsV2 page.

type ListRealtimeContactAnalysisSegmentsV2PaginatorOptions added in v1.82.0 

type ListRealtimeContactAnalysisSegmentsV2PaginatorOptions 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
}

ListRealtimeContactAnalysisSegmentsV2PaginatorOptions is the paginator options for ListRealtimeContactAnalysisSegmentsV2

type ListRoutingProfileQueuesAPIClient added in v0.30.0 

type ListRoutingProfileQueuesAPIClient interface {
	ListRoutingProfileQueues(context.Context, *ListRoutingProfileQueuesInput, ...func(*Options)) (*ListRoutingProfileQueuesOutput, error)
}

ListRoutingProfileQueuesAPIClient is a client that implements the ListRoutingProfileQueues operation.

type ListRoutingProfileQueuesInput added in v0.29.0 

type ListRoutingProfileQueuesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRoutingProfileQueuesOutput added in v0.29.0 

type ListRoutingProfileQueuesOutput struct {

	// The Amazon Web Services Region where this resource was last modified.
	LastModifiedRegion *string

	// The timestamp when this resource was last modified.
	LastModifiedTime *time.Time

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the routing profiles.
	RoutingProfileQueueConfigSummaryList []types.RoutingProfileQueueConfigSummary

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

type ListRoutingProfileQueuesPaginator added in v0.30.0 

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

ListRoutingProfileQueuesPaginator is a paginator for ListRoutingProfileQueues

func NewListRoutingProfileQueuesPaginator added in v0.30.0 

func NewListRoutingProfileQueuesPaginator(client ListRoutingProfileQueuesAPIClient, params *ListRoutingProfileQueuesInput, optFns ...func(*ListRoutingProfileQueuesPaginatorOptions)) *ListRoutingProfileQueuesPaginator

NewListRoutingProfileQueuesPaginator returns a new ListRoutingProfileQueuesPaginator

func (*ListRoutingProfileQueuesPaginator) HasMorePages added in v0.30.0 

func (p *ListRoutingProfileQueuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRoutingProfileQueuesPaginator) NextPage added in v0.30.0 

func (p *ListRoutingProfileQueuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRoutingProfileQueuesOutput, error)

NextPage retrieves the next ListRoutingProfileQueues page.

type ListRoutingProfileQueuesPaginatorOptions added in v0.30.0 

type ListRoutingProfileQueuesPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListRoutingProfileQueuesPaginatorOptions is the paginator options for ListRoutingProfileQueues

type ListRoutingProfilesAPIClient added in v0.30.0 

type ListRoutingProfilesAPIClient interface {
	ListRoutingProfiles(context.Context, *ListRoutingProfilesInput, ...func(*Options)) (*ListRoutingProfilesOutput, error)
}

ListRoutingProfilesAPIClient is a client that implements the ListRoutingProfiles operation.

type ListRoutingProfilesInput 

type ListRoutingProfilesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRoutingProfilesOutput 

type ListRoutingProfilesOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the routing profiles.
	RoutingProfileSummaryList []types.RoutingProfileSummary

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

type ListRoutingProfilesPaginator added in v0.30.0 

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

ListRoutingProfilesPaginator is a paginator for ListRoutingProfiles

func NewListRoutingProfilesPaginator added in v0.30.0 

func NewListRoutingProfilesPaginator(client ListRoutingProfilesAPIClient, params *ListRoutingProfilesInput, optFns ...func(*ListRoutingProfilesPaginatorOptions)) *ListRoutingProfilesPaginator

NewListRoutingProfilesPaginator returns a new ListRoutingProfilesPaginator

func (*ListRoutingProfilesPaginator) HasMorePages added in v0.30.0 

func (p *ListRoutingProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRoutingProfilesPaginator) NextPage added in v0.30.0 

func (p *ListRoutingProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRoutingProfilesOutput, error)

NextPage retrieves the next ListRoutingProfiles page.

type ListRoutingProfilesPaginatorOptions added in v0.30.0 

type ListRoutingProfilesPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListRoutingProfilesPaginatorOptions is the paginator options for ListRoutingProfiles

type ListRulesAPIClient added in v1.39.0 

type ListRulesAPIClient interface {
	ListRules(context.Context, *ListRulesInput, ...func(*Options)) (*ListRulesOutput, error)
}

ListRulesAPIClient is a client that implements the ListRules operation.

type ListRulesInput added in v1.39.0 

type ListRulesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the event source.
	EventSourceName types.EventSourceName

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The publish status of the rule.
	PublishStatus types.RulePublishStatus
	// contains filtered or unexported fields
}

type ListRulesOutput added in v1.39.0 

type ListRulesOutput struct {

	// Summary information about a rule.
	//
	// This member is required.
	RuleSummaryList []types.RuleSummary

	// If there are additional results, this is 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
}

type ListRulesPaginator added in v1.39.0 

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

ListRulesPaginator is a paginator for ListRules

func NewListRulesPaginator added in v1.39.0 

func NewListRulesPaginator(client ListRulesAPIClient, params *ListRulesInput, optFns ...func(*ListRulesPaginatorOptions)) *ListRulesPaginator

NewListRulesPaginator returns a new ListRulesPaginator

func (*ListRulesPaginator) HasMorePages added in v1.39.0 

func (p *ListRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRulesPaginator) NextPage added in v1.39.0 

func (p *ListRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRulesOutput, error)

NextPage retrieves the next ListRules page.

type ListRulesPaginatorOptions added in v1.39.0 

type ListRulesPaginatorOptions 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
}

ListRulesPaginatorOptions is the paginator options for ListRules

type ListSecurityKeysAPIClient added in v0.30.0 

type ListSecurityKeysAPIClient interface {
	ListSecurityKeys(context.Context, *ListSecurityKeysInput, ...func(*Options)) (*ListSecurityKeysOutput, error)
}

ListSecurityKeysAPIClient is a client that implements the ListSecurityKeys operation.

type ListSecurityKeysInput added in v0.30.0 

type ListSecurityKeysInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSecurityKeysOutput added in v0.30.0 

type ListSecurityKeysOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// The security keys.
	SecurityKeys []types.SecurityKey

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

type ListSecurityKeysPaginator added in v0.30.0 

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

ListSecurityKeysPaginator is a paginator for ListSecurityKeys

func NewListSecurityKeysPaginator added in v0.30.0 

func NewListSecurityKeysPaginator(client ListSecurityKeysAPIClient, params *ListSecurityKeysInput, optFns ...func(*ListSecurityKeysPaginatorOptions)) *ListSecurityKeysPaginator

NewListSecurityKeysPaginator returns a new ListSecurityKeysPaginator

func (*ListSecurityKeysPaginator) HasMorePages added in v0.30.0 

func (p *ListSecurityKeysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSecurityKeysPaginator) NextPage added in v0.30.0 

func (p *ListSecurityKeysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecurityKeysOutput, error)

NextPage retrieves the next ListSecurityKeys page.

type ListSecurityKeysPaginatorOptions added in v0.30.0 

type ListSecurityKeysPaginatorOptions 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
}

ListSecurityKeysPaginatorOptions is the paginator options for ListSecurityKeys

type ListSecurityProfileApplicationsAPIClient added in v1.68.0 

type ListSecurityProfileApplicationsAPIClient interface {
	ListSecurityProfileApplications(context.Context, *ListSecurityProfileApplicationsInput, ...func(*Options)) (*ListSecurityProfileApplicationsOutput, error)
}

ListSecurityProfileApplicationsAPIClient is a client that implements the ListSecurityProfileApplications operation.

type ListSecurityProfileApplicationsInput added in v1.68.0 

type ListSecurityProfileApplicationsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the security profle.
	//
	// This member is required.
	SecurityProfileId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSecurityProfileApplicationsOutput added in v1.68.0 

type ListSecurityProfileApplicationsOutput struct {

	// A list of the third-party application's metadata.
	Applications []types.Application

	// The Amazon Web Services Region where this resource was last modified.
	LastModifiedRegion *string

	// The timestamp when this resource was last modified.
	LastModifiedTime *time.Time

	// If there are additional results, this is 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
}

type ListSecurityProfileApplicationsPaginator added in v1.68.0 

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

ListSecurityProfileApplicationsPaginator is a paginator for ListSecurityProfileApplications

func NewListSecurityProfileApplicationsPaginator added in v1.68.0 

func NewListSecurityProfileApplicationsPaginator(client ListSecurityProfileApplicationsAPIClient, params *ListSecurityProfileApplicationsInput, optFns ...func(*ListSecurityProfileApplicationsPaginatorOptions)) *ListSecurityProfileApplicationsPaginator

NewListSecurityProfileApplicationsPaginator returns a new ListSecurityProfileApplicationsPaginator

func (*ListSecurityProfileApplicationsPaginator) HasMorePages added in v1.68.0 

func (p *ListSecurityProfileApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSecurityProfileApplicationsPaginator) NextPage added in v1.68.0 

func (p *ListSecurityProfileApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecurityProfileApplicationsOutput, error)

NextPage retrieves the next ListSecurityProfileApplications page.

type ListSecurityProfileApplicationsPaginatorOptions added in v1.68.0 

type ListSecurityProfileApplicationsPaginatorOptions 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
}

ListSecurityProfileApplicationsPaginatorOptions is the paginator options for ListSecurityProfileApplications

type ListSecurityProfilePermissionsAPIClient added in v1.11.0 

type ListSecurityProfilePermissionsAPIClient interface {
	ListSecurityProfilePermissions(context.Context, *ListSecurityProfilePermissionsInput, ...func(*Options)) (*ListSecurityProfilePermissionsOutput, error)
}

ListSecurityProfilePermissionsAPIClient is a client that implements the ListSecurityProfilePermissions operation.

type ListSecurityProfilePermissionsInput added in v1.11.0 

type ListSecurityProfilePermissionsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the security profle.
	//
	// This member is required.
	SecurityProfileId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSecurityProfilePermissionsOutput added in v1.11.0 

type ListSecurityProfilePermissionsOutput struct {

	// The Amazon Web Services Region where this resource was last modified.
	LastModifiedRegion *string

	// The timestamp when this resource was last modified.
	LastModifiedTime *time.Time

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// The permissions granted to the security profile. For a complete list of valid
	// permissions, see List of security profile permissions (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html)
	// .
	Permissions []string

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

type ListSecurityProfilePermissionsPaginator added in v1.11.0 

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

ListSecurityProfilePermissionsPaginator is a paginator for ListSecurityProfilePermissions

func NewListSecurityProfilePermissionsPaginator added in v1.11.0 

func NewListSecurityProfilePermissionsPaginator(client ListSecurityProfilePermissionsAPIClient, params *ListSecurityProfilePermissionsInput, optFns ...func(*ListSecurityProfilePermissionsPaginatorOptions)) *ListSecurityProfilePermissionsPaginator

NewListSecurityProfilePermissionsPaginator returns a new ListSecurityProfilePermissionsPaginator

func (*ListSecurityProfilePermissionsPaginator) HasMorePages added in v1.11.0 

func (p *ListSecurityProfilePermissionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSecurityProfilePermissionsPaginator) NextPage added in v1.11.0 

func (p *ListSecurityProfilePermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecurityProfilePermissionsOutput, error)

NextPage retrieves the next ListSecurityProfilePermissions page.

type ListSecurityProfilePermissionsPaginatorOptions added in v1.11.0 

type ListSecurityProfilePermissionsPaginatorOptions 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
}

ListSecurityProfilePermissionsPaginatorOptions is the paginator options for ListSecurityProfilePermissions

type ListSecurityProfilesAPIClient added in v0.30.0 

type ListSecurityProfilesAPIClient interface {
	ListSecurityProfiles(context.Context, *ListSecurityProfilesInput, ...func(*Options)) (*ListSecurityProfilesOutput, error)
}

ListSecurityProfilesAPIClient is a client that implements the ListSecurityProfiles operation.

type ListSecurityProfilesInput 

type ListSecurityProfilesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSecurityProfilesOutput 

type ListSecurityProfilesOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the security profiles.
	SecurityProfileSummaryList []types.SecurityProfileSummary

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

type ListSecurityProfilesPaginator added in v0.30.0 

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

ListSecurityProfilesPaginator is a paginator for ListSecurityProfiles

func NewListSecurityProfilesPaginator added in v0.30.0 

func NewListSecurityProfilesPaginator(client ListSecurityProfilesAPIClient, params *ListSecurityProfilesInput, optFns ...func(*ListSecurityProfilesPaginatorOptions)) *ListSecurityProfilesPaginator

NewListSecurityProfilesPaginator returns a new ListSecurityProfilesPaginator

func (*ListSecurityProfilesPaginator) HasMorePages added in v0.30.0 

func (p *ListSecurityProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSecurityProfilesPaginator) NextPage added in v0.30.0 

func (p *ListSecurityProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecurityProfilesOutput, error)

NextPage retrieves the next ListSecurityProfiles page.

type ListSecurityProfilesPaginatorOptions added in v0.30.0 

type ListSecurityProfilesPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListSecurityProfilesPaginatorOptions is the paginator options for ListSecurityProfiles

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources
	// (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN
	// for an instance, for example, see Find your Amazon Connect instance ID/ARN (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// .
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Information about the tags.
	Tags map[string]string

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

type ListTaskTemplatesAPIClient added in v1.25.0 

type ListTaskTemplatesAPIClient interface {
	ListTaskTemplates(context.Context, *ListTaskTemplatesInput, ...func(*Options)) (*ListTaskTemplatesOutput, error)
}

ListTaskTemplatesAPIClient is a client that implements the ListTaskTemplates operation.

type ListTaskTemplatesInput added in v1.25.0 

type ListTaskTemplatesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. It is not expected that you
	// set this.
	MaxResults *int32

	// The name of the task template.
	Name *string

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results. It is not
	// expected that you set this because the value returned in the previous response
	// is always null.
	NextToken *string

	// Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
	// only be created from ACTIVE templates. If a template is marked as INACTIVE ,
	// then a task that refers to this template cannot be created.
	Status types.TaskTemplateStatus
	// contains filtered or unexported fields
}

type ListTaskTemplatesOutput added in v1.25.0 

type ListTaskTemplatesOutput struct {

	// If there are additional results, this is the token for the next set of results.
	// This is always returned as a null in the response.
	NextToken *string

	// Provides details about a list of task templates belonging to an instance.
	TaskTemplates []types.TaskTemplateMetadata

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

type ListTaskTemplatesPaginator added in v1.25.0 

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

ListTaskTemplatesPaginator is a paginator for ListTaskTemplates

func NewListTaskTemplatesPaginator added in v1.25.0 

func NewListTaskTemplatesPaginator(client ListTaskTemplatesAPIClient, params *ListTaskTemplatesInput, optFns ...func(*ListTaskTemplatesPaginatorOptions)) *ListTaskTemplatesPaginator

NewListTaskTemplatesPaginator returns a new ListTaskTemplatesPaginator

func (*ListTaskTemplatesPaginator) HasMorePages added in v1.25.0 

func (p *ListTaskTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTaskTemplatesPaginator) NextPage added in v1.25.0 

func (p *ListTaskTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTaskTemplatesOutput, error)

NextPage retrieves the next ListTaskTemplates page.

type ListTaskTemplatesPaginatorOptions added in v1.25.0 

type ListTaskTemplatesPaginatorOptions struct {
	// The maximum number of results to return per page. It is not expected that you
	// set this.
	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
}

ListTaskTemplatesPaginatorOptions is the paginator options for ListTaskTemplates

type ListTrafficDistributionGroupUsersAPIClient added in v1.65.0 

type ListTrafficDistributionGroupUsersAPIClient interface {
	ListTrafficDistributionGroupUsers(context.Context, *ListTrafficDistributionGroupUsersInput, ...func(*Options)) (*ListTrafficDistributionGroupUsersOutput, error)
}

ListTrafficDistributionGroupUsersAPIClient is a client that implements the ListTrafficDistributionGroupUsers operation.

type ListTrafficDistributionGroupUsersInput added in v1.65.0 

type ListTrafficDistributionGroupUsersInput struct {

	// The identifier of the traffic distribution group. This can be the ID or the ARN
	// if the API is being called in the Region where the traffic distribution group
	// was created. The ARN must be provided if the call is from the replicated Region.
	//
	// This member is required.
	TrafficDistributionGroupId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTrafficDistributionGroupUsersOutput added in v1.65.0 

type ListTrafficDistributionGroupUsersOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// A list of traffic distribution group users.
	TrafficDistributionGroupUserSummaryList []types.TrafficDistributionGroupUserSummary

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

type ListTrafficDistributionGroupUsersPaginator added in v1.65.0 

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

ListTrafficDistributionGroupUsersPaginator is a paginator for ListTrafficDistributionGroupUsers

func NewListTrafficDistributionGroupUsersPaginator added in v1.65.0 

func NewListTrafficDistributionGroupUsersPaginator(client ListTrafficDistributionGroupUsersAPIClient, params *ListTrafficDistributionGroupUsersInput, optFns ...func(*ListTrafficDistributionGroupUsersPaginatorOptions)) *ListTrafficDistributionGroupUsersPaginator

NewListTrafficDistributionGroupUsersPaginator returns a new ListTrafficDistributionGroupUsersPaginator

func (*ListTrafficDistributionGroupUsersPaginator) HasMorePages added in v1.65.0 

func (p *ListTrafficDistributionGroupUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrafficDistributionGroupUsersPaginator) NextPage added in v1.65.0 

func (p *ListTrafficDistributionGroupUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTrafficDistributionGroupUsersOutput, error)

NextPage retrieves the next ListTrafficDistributionGroupUsers page.

type ListTrafficDistributionGroupUsersPaginatorOptions added in v1.65.0 

type ListTrafficDistributionGroupUsersPaginatorOptions 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
}

ListTrafficDistributionGroupUsersPaginatorOptions is the paginator options for ListTrafficDistributionGroupUsers

type ListTrafficDistributionGroupsAPIClient added in v1.33.0 

type ListTrafficDistributionGroupsAPIClient interface {
	ListTrafficDistributionGroups(context.Context, *ListTrafficDistributionGroupsInput, ...func(*Options)) (*ListTrafficDistributionGroupsOutput, error)
}

ListTrafficDistributionGroupsAPIClient is a client that implements the ListTrafficDistributionGroups operation.

type ListTrafficDistributionGroupsInput added in v1.33.0 

type ListTrafficDistributionGroupsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTrafficDistributionGroupsOutput added in v1.33.0 

type ListTrafficDistributionGroupsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// A list of traffic distribution groups.
	TrafficDistributionGroupSummaryList []types.TrafficDistributionGroupSummary

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

type ListTrafficDistributionGroupsPaginator added in v1.33.0 

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

ListTrafficDistributionGroupsPaginator is a paginator for ListTrafficDistributionGroups

func NewListTrafficDistributionGroupsPaginator added in v1.33.0 

func NewListTrafficDistributionGroupsPaginator(client ListTrafficDistributionGroupsAPIClient, params *ListTrafficDistributionGroupsInput, optFns ...func(*ListTrafficDistributionGroupsPaginatorOptions)) *ListTrafficDistributionGroupsPaginator

NewListTrafficDistributionGroupsPaginator returns a new ListTrafficDistributionGroupsPaginator

func (*ListTrafficDistributionGroupsPaginator) HasMorePages added in v1.33.0 

func (p *ListTrafficDistributionGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrafficDistributionGroupsPaginator) NextPage added in v1.33.0 

func (p *ListTrafficDistributionGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTrafficDistributionGroupsOutput, error)

NextPage retrieves the next ListTrafficDistributionGroups page.

type ListTrafficDistributionGroupsPaginatorOptions added in v1.33.0 

type ListTrafficDistributionGroupsPaginatorOptions 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
}

ListTrafficDistributionGroupsPaginatorOptions is the paginator options for ListTrafficDistributionGroups

type ListUseCasesAPIClient added in v0.31.0 

type ListUseCasesAPIClient interface {
	ListUseCases(context.Context, *ListUseCasesInput, ...func(*Options)) (*ListUseCasesOutput, error)
}

ListUseCasesAPIClient is a client that implements the ListUseCases operation.

type ListUseCasesInput added in v0.31.0 

type ListUseCasesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the integration association.
	//
	// This member is required.
	IntegrationAssociationId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

Provides summary information about the use cases for the specified integration association.

type ListUseCasesOutput added in v0.31.0 

type ListUseCasesOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// The use cases.
	UseCaseSummaryList []types.UseCase

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

type ListUseCasesPaginator added in v0.31.0 

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

ListUseCasesPaginator is a paginator for ListUseCases

func NewListUseCasesPaginator added in v0.31.0 

func NewListUseCasesPaginator(client ListUseCasesAPIClient, params *ListUseCasesInput, optFns ...func(*ListUseCasesPaginatorOptions)) *ListUseCasesPaginator

NewListUseCasesPaginator returns a new ListUseCasesPaginator

func (*ListUseCasesPaginator) HasMorePages added in v0.31.0 

func (p *ListUseCasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUseCasesPaginator) NextPage added in v0.31.0 

func (p *ListUseCasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUseCasesOutput, error)

NextPage retrieves the next ListUseCases page.

type ListUseCasesPaginatorOptions added in v0.31.0 

type ListUseCasesPaginatorOptions 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
}

ListUseCasesPaginatorOptions is the paginator options for ListUseCases

type ListUserHierarchyGroupsAPIClient added in v0.30.0 

type ListUserHierarchyGroupsAPIClient interface {
	ListUserHierarchyGroups(context.Context, *ListUserHierarchyGroupsInput, ...func(*Options)) (*ListUserHierarchyGroupsOutput, error)
}

ListUserHierarchyGroupsAPIClient is a client that implements the ListUserHierarchyGroups operation.

type ListUserHierarchyGroupsInput 

type ListUserHierarchyGroupsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUserHierarchyGroupsOutput 

type ListUserHierarchyGroupsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the hierarchy groups.
	UserHierarchyGroupSummaryList []types.HierarchyGroupSummary

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

type ListUserHierarchyGroupsPaginator added in v0.30.0 

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

ListUserHierarchyGroupsPaginator is a paginator for ListUserHierarchyGroups

func NewListUserHierarchyGroupsPaginator added in v0.30.0 

func NewListUserHierarchyGroupsPaginator(client ListUserHierarchyGroupsAPIClient, params *ListUserHierarchyGroupsInput, optFns ...func(*ListUserHierarchyGroupsPaginatorOptions)) *ListUserHierarchyGroupsPaginator

NewListUserHierarchyGroupsPaginator returns a new ListUserHierarchyGroupsPaginator

func (*ListUserHierarchyGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListUserHierarchyGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUserHierarchyGroupsPaginator) NextPage added in v0.30.0 

func (p *ListUserHierarchyGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUserHierarchyGroupsOutput, error)

NextPage retrieves the next ListUserHierarchyGroups page.

type ListUserHierarchyGroupsPaginatorOptions added in v0.30.0 

type ListUserHierarchyGroupsPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListUserHierarchyGroupsPaginatorOptions is the paginator options for ListUserHierarchyGroups

type ListUserProficienciesAPIClient added in v1.87.0 

type ListUserProficienciesAPIClient interface {
	ListUserProficiencies(context.Context, *ListUserProficienciesInput, ...func(*Options)) (*ListUserProficienciesOutput, error)
}

ListUserProficienciesAPIClient is a client that implements the ListUserProficiencies operation.

type ListUserProficienciesInput added in v1.87.0 

type ListUserProficienciesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUserProficienciesOutput added in v1.87.0 

type ListUserProficienciesOutput struct {

	// The region in which a user's proficiencies were last modified.
	LastModifiedRegion *string

	// The last time that the user's proficiencies are were modified.
	LastModifiedTime *time.Time

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the user proficiencies.
	UserProficiencyList []types.UserProficiency

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

type ListUserProficienciesPaginator added in v1.87.0 

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

ListUserProficienciesPaginator is a paginator for ListUserProficiencies

func NewListUserProficienciesPaginator added in v1.87.0 

func NewListUserProficienciesPaginator(client ListUserProficienciesAPIClient, params *ListUserProficienciesInput, optFns ...func(*ListUserProficienciesPaginatorOptions)) *ListUserProficienciesPaginator

NewListUserProficienciesPaginator returns a new ListUserProficienciesPaginator

func (*ListUserProficienciesPaginator) HasMorePages added in v1.87.0 

func (p *ListUserProficienciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUserProficienciesPaginator) NextPage added in v1.87.0 

func (p *ListUserProficienciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUserProficienciesOutput, error)

NextPage retrieves the next ListUserProficiencies page.

type ListUserProficienciesPaginatorOptions added in v1.87.0 

type ListUserProficienciesPaginatorOptions 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
}

ListUserProficienciesPaginatorOptions is the paginator options for ListUserProficiencies

type ListUsersAPIClient added in v0.30.0 

type ListUsersAPIClient interface {
	ListUsers(context.Context, *ListUsersInput, ...func(*Options)) (*ListUsersOutput, error)
}

ListUsersAPIClient is a client that implements the ListUsers operation.

type ListUsersInput 

type ListUsersInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUsersOutput 

type ListUsersOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the users.
	UserSummaryList []types.UserSummary

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

type ListUsersPaginator added in v0.30.0 

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

ListUsersPaginator is a paginator for ListUsers

func NewListUsersPaginator added in v0.30.0 

func NewListUsersPaginator(client ListUsersAPIClient, params *ListUsersInput, optFns ...func(*ListUsersPaginatorOptions)) *ListUsersPaginator

NewListUsersPaginator returns a new ListUsersPaginator

func (*ListUsersPaginator) HasMorePages added in v0.30.0 

func (p *ListUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUsersPaginator) NextPage added in v0.30.0 

func (p *ListUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsersOutput, error)

NextPage retrieves the next ListUsers page.

type ListUsersPaginatorOptions added in v0.30.0 

type ListUsersPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListUsersPaginatorOptions is the paginator options for ListUsers

type ListViewVersionsAPIClient added in v1.66.0 

type ListViewVersionsAPIClient interface {
	ListViewVersions(context.Context, *ListViewVersionsInput, ...func(*Options)) (*ListViewVersionsOutput, error)
}

ListViewVersionsAPIClient is a client that implements the ListViewVersions operation.

type ListViewVersionsInput added in v1.66.0 

type ListViewVersionsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the view. Both ViewArn and ViewId can be used.
	//
	// This member is required.
	ViewId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListViewVersionsOutput added in v1.66.0 

type ListViewVersionsOutput struct {

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// A list of view version summaries.
	ViewVersionSummaryList []types.ViewVersionSummary

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

type ListViewVersionsPaginator added in v1.66.0 

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

ListViewVersionsPaginator is a paginator for ListViewVersions

func NewListViewVersionsPaginator added in v1.66.0 

func NewListViewVersionsPaginator(client ListViewVersionsAPIClient, params *ListViewVersionsInput, optFns ...func(*ListViewVersionsPaginatorOptions)) *ListViewVersionsPaginator

NewListViewVersionsPaginator returns a new ListViewVersionsPaginator

func (*ListViewVersionsPaginator) HasMorePages added in v1.66.0 

func (p *ListViewVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListViewVersionsPaginator) NextPage added in v1.66.0 

func (p *ListViewVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListViewVersionsOutput, error)

NextPage retrieves the next ListViewVersions page.

type ListViewVersionsPaginatorOptions added in v1.66.0 

type ListViewVersionsPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListViewVersionsPaginatorOptions is the paginator options for ListViewVersions

type ListViewsAPIClient added in v1.66.0 

type ListViewsAPIClient interface {
	ListViews(context.Context, *ListViewsInput, ...func(*Options)) (*ListViewsOutput, error)
}

ListViewsAPIClient is a client that implements the ListViews operation.

type ListViewsInput added in v1.66.0 

type ListViewsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The type of the view.
	Type types.ViewType
	// contains filtered or unexported fields
}

type ListViewsOutput added in v1.66.0 

type ListViewsOutput struct {

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// A list of view summaries.
	ViewsSummaryList []types.ViewSummary

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

type ListViewsPaginator added in v1.66.0 

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

ListViewsPaginator is a paginator for ListViews

func NewListViewsPaginator added in v1.66.0 

func NewListViewsPaginator(client ListViewsAPIClient, params *ListViewsInput, optFns ...func(*ListViewsPaginatorOptions)) *ListViewsPaginator

NewListViewsPaginator returns a new ListViewsPaginator

func (*ListViewsPaginator) HasMorePages added in v1.66.0 

func (p *ListViewsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListViewsPaginator) NextPage added in v1.66.0 

func (p *ListViewsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListViewsOutput, error)

NextPage retrieves the next ListViews page.

type ListViewsPaginatorOptions added in v1.66.0 

type ListViewsPaginatorOptions struct {
	// The maximum number of results to return per page. The default MaxResult size is
	// 100.
	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
}

ListViewsPaginatorOptions is the paginator options for ListViews

type MonitorContactInput added in v1.37.0 

type MonitorContactInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string

	// Specify which monitoring actions the user is allowed to take. For example,
	// whether the user is allowed to escalate from silent monitoring to barge.
	// AllowedMonitorCapabilities is required if barge is enabled.
	AllowedMonitorCapabilities []types.MonitorCapability

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type MonitorContactOutput added in v1.37.0 

type MonitorContactOutput struct {

	// The ARN of the contact.
	ContactArn *string

	// The identifier of the contact.
	ContactId *string

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

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

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

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

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

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

type PauseContactInput added in v1.86.0 

type PauseContactInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the flow.
	ContactFlowId *string
	// contains filtered or unexported fields
}

type PauseContactOutput added in v1.86.0 

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

type PutUserStatusInput added in v1.24.0 

type PutUserStatusInput struct {

	// The identifier of the agent status.
	//
	// This member is required.
	AgentStatusId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type PutUserStatusOutput added in v1.24.0 

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

type ReleasePhoneNumberInput added in v1.22.0 

type ReleasePhoneNumberInput struct {

	// A unique identifier for the phone number.
	//
	// This member is required.
	PhoneNumberId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type ReleasePhoneNumberOutput added in v1.22.0 

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

type ReplicateInstanceInput added in v1.33.0 

type ReplicateInstanceInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance. You can provide the
	// InstanceId , or the entire ARN.
	//
	// This member is required.
	InstanceId *string

	// The alias for the replicated instance. The ReplicaAlias must be unique.
	//
	// This member is required.
	ReplicaAlias *string

	// The Amazon Web Services Region where to replicate the Amazon Connect instance.
	//
	// This member is required.
	ReplicaRegion *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type ReplicateInstanceOutput added in v1.33.0 

type ReplicateInstanceOutput struct {

	// The Amazon Resource Name (ARN) of the replicated instance.
	Arn *string

	// The identifier of the replicated instance. You can find the instanceId in the
	// ARN of the instance. The replicated instance has the same identifier as the
	// instance it was replicated from.
	Id *string

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

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 ResumeContactInput added in v1.86.0 

type ResumeContactInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the flow.
	ContactFlowId *string
	// contains filtered or unexported fields
}

type ResumeContactOutput added in v1.86.0 

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

type ResumeContactRecordingInput 

type ResumeContactRecordingInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the contact. This is the identifier of the contact associated
	// with the first interaction with the contact center.
	//
	// This member is required.
	InitialContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type ResumeContactRecordingOutput 

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

type SearchAvailablePhoneNumbersAPIClient added in v1.22.0 

type SearchAvailablePhoneNumbersAPIClient interface {
	SearchAvailablePhoneNumbers(context.Context, *SearchAvailablePhoneNumbersInput, ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error)
}

SearchAvailablePhoneNumbersAPIClient is a client that implements the SearchAvailablePhoneNumbers operation.

type SearchAvailablePhoneNumbersInput added in v1.22.0 

type SearchAvailablePhoneNumbersInput struct {

	// The ISO country code.
	//
	// This member is required.
	PhoneNumberCountryCode types.PhoneNumberCountryCode

	// The type of phone number.
	//
	// This member is required.
	PhoneNumberType types.PhoneNumberType

	// The identifier of the Amazon Connect instance that phone numbers are claimed
	// to. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or
	// TargetArn .
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The prefix of the phone number. If provided, it must contain + as part of the
	// country code.
	PhoneNumberPrefix *string

	// The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
	// distribution groups that phone number inbound traffic is routed through. You
	// must enter InstanceId or TargetArn .
	TargetArn *string
	// contains filtered or unexported fields
}

type SearchAvailablePhoneNumbersOutput added in v1.22.0 

type SearchAvailablePhoneNumbersOutput struct {

	// A list of available phone numbers that you can claim to your Amazon Connect
	// instance or traffic distribution group.
	AvailableNumbersList []types.AvailableNumberSummary

	// If there are additional results, this is 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
}

type SearchAvailablePhoneNumbersPaginator added in v1.22.0 

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

SearchAvailablePhoneNumbersPaginator is a paginator for SearchAvailablePhoneNumbers

func NewSearchAvailablePhoneNumbersPaginator added in v1.22.0 

func NewSearchAvailablePhoneNumbersPaginator(client SearchAvailablePhoneNumbersAPIClient, params *SearchAvailablePhoneNumbersInput, optFns ...func(*SearchAvailablePhoneNumbersPaginatorOptions)) *SearchAvailablePhoneNumbersPaginator

NewSearchAvailablePhoneNumbersPaginator returns a new SearchAvailablePhoneNumbersPaginator

func (*SearchAvailablePhoneNumbersPaginator) HasMorePages added in v1.22.0 

func (p *SearchAvailablePhoneNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchAvailablePhoneNumbersPaginator) NextPage added in v1.22.0 

func (p *SearchAvailablePhoneNumbersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error)

NextPage retrieves the next SearchAvailablePhoneNumbers page.

type SearchAvailablePhoneNumbersPaginatorOptions added in v1.22.0 

type SearchAvailablePhoneNumbersPaginatorOptions 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
}

SearchAvailablePhoneNumbersPaginatorOptions is the paginator options for SearchAvailablePhoneNumbers

type SearchContactsAPIClient added in v1.87.0 

type SearchContactsAPIClient interface {
	SearchContacts(context.Context, *SearchContactsInput, ...func(*Options)) (*SearchContactsOutput, error)
}

SearchContactsAPIClient is a client that implements the SearchContacts operation.

type SearchContactsInput added in v1.87.0 

type SearchContactsInput struct {

	// The identifier of Amazon Connect instance. You can find the instance ID in the
	// Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Time range that you want to search results.
	//
	// This member is required.
	TimeRange *types.SearchContactsTimeRange

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search criteria to be used to return contacts.
	SearchCriteria *types.SearchCriteria

	// Specifies a field to sort by and a sort order.
	Sort *types.Sort
	// contains filtered or unexported fields
}

type SearchContactsOutput added in v1.87.0 

type SearchContactsOutput struct {

	// Information about the contacts.
	//
	// This member is required.
	Contacts []types.ContactSearchSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// The total number of contacts which matched your search query.
	TotalCount *int64

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

type SearchContactsPaginator added in v1.87.0 

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

SearchContactsPaginator is a paginator for SearchContacts

func NewSearchContactsPaginator added in v1.87.0 

func NewSearchContactsPaginator(client SearchContactsAPIClient, params *SearchContactsInput, optFns ...func(*SearchContactsPaginatorOptions)) *SearchContactsPaginator

NewSearchContactsPaginator returns a new SearchContactsPaginator

func (*SearchContactsPaginator) HasMorePages added in v1.87.0 

func (p *SearchContactsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchContactsPaginator) NextPage added in v1.87.0 

func (p *SearchContactsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchContactsOutput, error)

NextPage retrieves the next SearchContacts page.

type SearchContactsPaginatorOptions added in v1.87.0 

type SearchContactsPaginatorOptions 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
}

SearchContactsPaginatorOptions is the paginator options for SearchContacts

type SearchHoursOfOperationsAPIClient added in v1.58.0 

type SearchHoursOfOperationsAPIClient interface {
	SearchHoursOfOperations(context.Context, *SearchHoursOfOperationsInput, ...func(*Options)) (*SearchHoursOfOperationsOutput, error)
}

SearchHoursOfOperationsAPIClient is a client that implements the SearchHoursOfOperations operation.

type SearchHoursOfOperationsInput added in v1.58.0 

type SearchHoursOfOperationsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search criteria to be used to return hours of operations.
	SearchCriteria *types.HoursOfOperationSearchCriteria

	// Filters to be applied to search results.
	SearchFilter *types.HoursOfOperationSearchFilter
	// contains filtered or unexported fields
}

type SearchHoursOfOperationsOutput added in v1.58.0 

type SearchHoursOfOperationsOutput struct {

	// The total number of hours of operations which matched your search query.
	ApproximateTotalCount *int64

	// Information about the hours of operations.
	HoursOfOperations []types.HoursOfOperation

	// If there are additional results, this is 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
}

type SearchHoursOfOperationsPaginator added in v1.58.0 

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

SearchHoursOfOperationsPaginator is a paginator for SearchHoursOfOperations

func NewSearchHoursOfOperationsPaginator added in v1.58.0 

func NewSearchHoursOfOperationsPaginator(client SearchHoursOfOperationsAPIClient, params *SearchHoursOfOperationsInput, optFns ...func(*SearchHoursOfOperationsPaginatorOptions)) *SearchHoursOfOperationsPaginator

NewSearchHoursOfOperationsPaginator returns a new SearchHoursOfOperationsPaginator

func (*SearchHoursOfOperationsPaginator) HasMorePages added in v1.58.0 

func (p *SearchHoursOfOperationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchHoursOfOperationsPaginator) NextPage added in v1.58.0 

func (p *SearchHoursOfOperationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchHoursOfOperationsOutput, error)

NextPage retrieves the next SearchHoursOfOperations page.

type SearchHoursOfOperationsPaginatorOptions added in v1.58.0 

type SearchHoursOfOperationsPaginatorOptions 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
}

SearchHoursOfOperationsPaginatorOptions is the paginator options for SearchHoursOfOperations

type SearchPredefinedAttributesAPIClient added in v1.87.0 

type SearchPredefinedAttributesAPIClient interface {
	SearchPredefinedAttributes(context.Context, *SearchPredefinedAttributesInput, ...func(*Options)) (*SearchPredefinedAttributesOutput, error)
}

SearchPredefinedAttributesAPIClient is a client that implements the SearchPredefinedAttributes operation.

type SearchPredefinedAttributesInput added in v1.87.0 

type SearchPredefinedAttributesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search criteria to be used to return predefined attributes.
	SearchCriteria *types.PredefinedAttributeSearchCriteria
	// contains filtered or unexported fields
}

type SearchPredefinedAttributesOutput added in v1.87.0 

type SearchPredefinedAttributesOutput struct {

	// The approximate number of predefined attributes which matched your search query.
	ApproximateTotalCount *int64

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// Predefined attributes matched by the search criteria.
	PredefinedAttributes []types.PredefinedAttribute

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

type SearchPredefinedAttributesPaginator added in v1.87.0 

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

SearchPredefinedAttributesPaginator is a paginator for SearchPredefinedAttributes

func NewSearchPredefinedAttributesPaginator added in v1.87.0 

func NewSearchPredefinedAttributesPaginator(client SearchPredefinedAttributesAPIClient, params *SearchPredefinedAttributesInput, optFns ...func(*SearchPredefinedAttributesPaginatorOptions)) *SearchPredefinedAttributesPaginator

NewSearchPredefinedAttributesPaginator returns a new SearchPredefinedAttributesPaginator

func (*SearchPredefinedAttributesPaginator) HasMorePages added in v1.87.0 

func (p *SearchPredefinedAttributesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchPredefinedAttributesPaginator) NextPage added in v1.87.0 

func (p *SearchPredefinedAttributesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchPredefinedAttributesOutput, error)

NextPage retrieves the next SearchPredefinedAttributes page.

type SearchPredefinedAttributesPaginatorOptions added in v1.87.0 

type SearchPredefinedAttributesPaginatorOptions 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
}

SearchPredefinedAttributesPaginatorOptions is the paginator options for SearchPredefinedAttributes

type SearchPromptsAPIClient added in v1.58.0 

type SearchPromptsAPIClient interface {
	SearchPrompts(context.Context, *SearchPromptsInput, ...func(*Options)) (*SearchPromptsOutput, error)
}

SearchPromptsAPIClient is a client that implements the SearchPrompts operation.

type SearchPromptsInput added in v1.58.0 

type SearchPromptsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search criteria to be used to return prompts.
	SearchCriteria *types.PromptSearchCriteria

	// Filters to be applied to search results.
	SearchFilter *types.PromptSearchFilter
	// contains filtered or unexported fields
}

type SearchPromptsOutput added in v1.58.0 

type SearchPromptsOutput struct {

	// The total number of quick connects which matched your search query.
	ApproximateTotalCount *int64

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the prompts.
	Prompts []types.Prompt

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

type SearchPromptsPaginator added in v1.58.0 

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

SearchPromptsPaginator is a paginator for SearchPrompts

func NewSearchPromptsPaginator added in v1.58.0 

func NewSearchPromptsPaginator(client SearchPromptsAPIClient, params *SearchPromptsInput, optFns ...func(*SearchPromptsPaginatorOptions)) *SearchPromptsPaginator

NewSearchPromptsPaginator returns a new SearchPromptsPaginator

func (*SearchPromptsPaginator) HasMorePages added in v1.58.0 

func (p *SearchPromptsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchPromptsPaginator) NextPage added in v1.58.0 

func (p *SearchPromptsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchPromptsOutput, error)

NextPage retrieves the next SearchPrompts page.

type SearchPromptsPaginatorOptions added in v1.58.0 

type SearchPromptsPaginatorOptions 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
}

SearchPromptsPaginatorOptions is the paginator options for SearchPrompts

type SearchQueuesAPIClient added in v1.29.0 

type SearchQueuesAPIClient interface {
	SearchQueues(context.Context, *SearchQueuesInput, ...func(*Options)) (*SearchQueuesOutput, error)
}

SearchQueuesAPIClient is a client that implements the SearchQueues operation.

type SearchQueuesInput added in v1.29.0 

type SearchQueuesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search criteria to be used to return queues. The name and description
	// fields support "contains" queries with a minimum of 2 characters and a maximum
	// of 25 characters. Any queries with character lengths outside of this range will
	// throw invalid results.
	SearchCriteria *types.QueueSearchCriteria

	// Filters to be applied to search results.
	SearchFilter *types.QueueSearchFilter
	// contains filtered or unexported fields
}

type SearchQueuesOutput added in v1.29.0 

type SearchQueuesOutput struct {

	// The total number of queues which matched your search query.
	ApproximateTotalCount *int64

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the queues.
	Queues []types.Queue

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

type SearchQueuesPaginator added in v1.29.0 

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

SearchQueuesPaginator is a paginator for SearchQueues

func NewSearchQueuesPaginator added in v1.29.0 

func NewSearchQueuesPaginator(client SearchQueuesAPIClient, params *SearchQueuesInput, optFns ...func(*SearchQueuesPaginatorOptions)) *SearchQueuesPaginator

NewSearchQueuesPaginator returns a new SearchQueuesPaginator

func (*SearchQueuesPaginator) HasMorePages added in v1.29.0 

func (p *SearchQueuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchQueuesPaginator) NextPage added in v1.29.0 

func (p *SearchQueuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchQueuesOutput, error)

NextPage retrieves the next SearchQueues page.

type SearchQueuesPaginatorOptions added in v1.29.0 

type SearchQueuesPaginatorOptions 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
}

SearchQueuesPaginatorOptions is the paginator options for SearchQueues

type SearchQuickConnectsAPIClient added in v1.58.0 

type SearchQuickConnectsAPIClient interface {
	SearchQuickConnects(context.Context, *SearchQuickConnectsInput, ...func(*Options)) (*SearchQuickConnectsOutput, error)
}

SearchQuickConnectsAPIClient is a client that implements the SearchQuickConnects operation.

type SearchQuickConnectsInput added in v1.58.0 

type SearchQuickConnectsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search criteria to be used to return quick connects.
	SearchCriteria *types.QuickConnectSearchCriteria

	// Filters to be applied to search results.
	SearchFilter *types.QuickConnectSearchFilter
	// contains filtered or unexported fields
}

type SearchQuickConnectsOutput added in v1.58.0 

type SearchQuickConnectsOutput struct {

	// The total number of quick connects which matched your search query.
	ApproximateTotalCount *int64

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the quick connects.
	QuickConnects []types.QuickConnect

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

type SearchQuickConnectsPaginator added in v1.58.0 

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

SearchQuickConnectsPaginator is a paginator for SearchQuickConnects

func NewSearchQuickConnectsPaginator added in v1.58.0 

func NewSearchQuickConnectsPaginator(client SearchQuickConnectsAPIClient, params *SearchQuickConnectsInput, optFns ...func(*SearchQuickConnectsPaginatorOptions)) *SearchQuickConnectsPaginator

NewSearchQuickConnectsPaginator returns a new SearchQuickConnectsPaginator

func (*SearchQuickConnectsPaginator) HasMorePages added in v1.58.0 

func (p *SearchQuickConnectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchQuickConnectsPaginator) NextPage added in v1.58.0 

func (p *SearchQuickConnectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchQuickConnectsOutput, error)

NextPage retrieves the next SearchQuickConnects page.

type SearchQuickConnectsPaginatorOptions added in v1.58.0 

type SearchQuickConnectsPaginatorOptions 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
}

SearchQuickConnectsPaginatorOptions is the paginator options for SearchQuickConnects

type SearchResourceTagsAPIClient added in v1.60.0 

type SearchResourceTagsAPIClient interface {
	SearchResourceTags(context.Context, *SearchResourceTagsInput, ...func(*Options)) (*SearchResourceTagsOutput, error)
}

SearchResourceTagsAPIClient is a client that implements the SearchResourceTags operation.

type SearchResourceTagsInput added in v1.60.0 

type SearchResourceTagsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The list of resource types to be used to search tags from. If not provided or
	// if any empty list is provided, this API will search from all supported resource
	// types.
	ResourceTypes []string

	// The search criteria to be used to return tags.
	SearchCriteria *types.ResourceTagsSearchCriteria
	// contains filtered or unexported fields
}

type SearchResourceTagsOutput added in v1.60.0 

type SearchResourceTagsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// A list of tags used in the Amazon Connect instance.
	Tags []types.TagSet

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

type SearchResourceTagsPaginator added in v1.60.0 

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

SearchResourceTagsPaginator is a paginator for SearchResourceTags

func NewSearchResourceTagsPaginator added in v1.60.0 

func NewSearchResourceTagsPaginator(client SearchResourceTagsAPIClient, params *SearchResourceTagsInput, optFns ...func(*SearchResourceTagsPaginatorOptions)) *SearchResourceTagsPaginator

NewSearchResourceTagsPaginator returns a new SearchResourceTagsPaginator

func (*SearchResourceTagsPaginator) HasMorePages added in v1.60.0 

func (p *SearchResourceTagsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchResourceTagsPaginator) NextPage added in v1.60.0 

func (p *SearchResourceTagsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchResourceTagsOutput, error)

NextPage retrieves the next SearchResourceTags page.

type SearchResourceTagsPaginatorOptions added in v1.60.0 

type SearchResourceTagsPaginatorOptions 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
}

SearchResourceTagsPaginatorOptions is the paginator options for SearchResourceTags

type SearchRoutingProfilesAPIClient added in v1.29.0 

type SearchRoutingProfilesAPIClient interface {
	SearchRoutingProfiles(context.Context, *SearchRoutingProfilesInput, ...func(*Options)) (*SearchRoutingProfilesOutput, error)
}

SearchRoutingProfilesAPIClient is a client that implements the SearchRoutingProfiles operation.

type SearchRoutingProfilesInput added in v1.29.0 

type SearchRoutingProfilesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search criteria to be used to return routing profiles. The name and
	// description fields support "contains" queries with a minimum of 2 characters and
	// a maximum of 25 characters. Any queries with character lengths outside of this
	// range will throw invalid results.
	SearchCriteria *types.RoutingProfileSearchCriteria

	// Filters to be applied to search results.
	SearchFilter *types.RoutingProfileSearchFilter
	// contains filtered or unexported fields
}

type SearchRoutingProfilesOutput added in v1.29.0 

type SearchRoutingProfilesOutput struct {

	// The total number of routing profiles which matched your search query.
	ApproximateTotalCount *int64

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the routing profiles.
	RoutingProfiles []types.RoutingProfile

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

type SearchRoutingProfilesPaginator added in v1.29.0 

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

SearchRoutingProfilesPaginator is a paginator for SearchRoutingProfiles

func NewSearchRoutingProfilesPaginator added in v1.29.0 

func NewSearchRoutingProfilesPaginator(client SearchRoutingProfilesAPIClient, params *SearchRoutingProfilesInput, optFns ...func(*SearchRoutingProfilesPaginatorOptions)) *SearchRoutingProfilesPaginator

NewSearchRoutingProfilesPaginator returns a new SearchRoutingProfilesPaginator

func (*SearchRoutingProfilesPaginator) HasMorePages added in v1.29.0 

func (p *SearchRoutingProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchRoutingProfilesPaginator) NextPage added in v1.29.0 

func (p *SearchRoutingProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchRoutingProfilesOutput, error)

NextPage retrieves the next SearchRoutingProfiles page.

type SearchRoutingProfilesPaginatorOptions added in v1.29.0 

type SearchRoutingProfilesPaginatorOptions 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
}

SearchRoutingProfilesPaginatorOptions is the paginator options for SearchRoutingProfiles

type SearchSecurityProfilesAPIClient added in v1.28.0 

type SearchSecurityProfilesAPIClient interface {
	SearchSecurityProfiles(context.Context, *SearchSecurityProfilesInput, ...func(*Options)) (*SearchSecurityProfilesOutput, error)
}

SearchSecurityProfilesAPIClient is a client that implements the SearchSecurityProfiles operation.

type SearchSecurityProfilesInput added in v1.28.0 

type SearchSecurityProfilesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search criteria to be used to return security profiles. The name field
	// support "contains" queries with a minimum of 2 characters and maximum of 25
	// characters. Any queries with character lengths outside of this range will throw
	// invalid results. The currently supported value for FieldName : name
	SearchCriteria *types.SecurityProfileSearchCriteria

	// Filters to be applied to search results.
	SearchFilter *types.SecurityProfilesSearchFilter
	// contains filtered or unexported fields
}

type SearchSecurityProfilesOutput added in v1.28.0 

type SearchSecurityProfilesOutput struct {

	// The total number of security profiles which matched your search query.
	ApproximateTotalCount *int64

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the security profiles.
	SecurityProfiles []types.SecurityProfileSearchSummary

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

type SearchSecurityProfilesPaginator added in v1.28.0 

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

SearchSecurityProfilesPaginator is a paginator for SearchSecurityProfiles

func NewSearchSecurityProfilesPaginator added in v1.28.0 

func NewSearchSecurityProfilesPaginator(client SearchSecurityProfilesAPIClient, params *SearchSecurityProfilesInput, optFns ...func(*SearchSecurityProfilesPaginatorOptions)) *SearchSecurityProfilesPaginator

NewSearchSecurityProfilesPaginator returns a new SearchSecurityProfilesPaginator

func (*SearchSecurityProfilesPaginator) HasMorePages added in v1.28.0 

func (p *SearchSecurityProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchSecurityProfilesPaginator) NextPage added in v1.28.0 

func (p *SearchSecurityProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchSecurityProfilesOutput, error)

NextPage retrieves the next SearchSecurityProfiles page.

type SearchSecurityProfilesPaginatorOptions added in v1.28.0 

type SearchSecurityProfilesPaginatorOptions 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
}

SearchSecurityProfilesPaginatorOptions is the paginator options for SearchSecurityProfiles

type SearchUsersAPIClient added in v1.23.0 

type SearchUsersAPIClient interface {
	SearchUsers(context.Context, *SearchUsersInput, ...func(*Options)) (*SearchUsersOutput, error)
}

SearchUsersAPIClient is a client that implements the SearchUsers operation.

type SearchUsersInput added in v1.23.0 

type SearchUsersInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance. InstanceID is a required
	// field. The "Required: No" below is incorrect.
	//
	// This member is required.
	InstanceId *string

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

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search criteria to be used to return users. The name and description fields
	// support "contains" queries with a minimum of 2 characters and a maximum of 25
	// characters. Any queries with character lengths outside of this range will throw
	// invalid results.
	SearchCriteria *types.UserSearchCriteria

	// Filters to be applied to search results.
	SearchFilter *types.UserSearchFilter
	// contains filtered or unexported fields
}

type SearchUsersOutput added in v1.23.0 

type SearchUsersOutput struct {

	// The total number of users who matched your search query.
	ApproximateTotalCount *int64

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// Information about the users.
	Users []types.UserSearchSummary

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

type SearchUsersPaginator added in v1.23.0 

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

SearchUsersPaginator is a paginator for SearchUsers

func NewSearchUsersPaginator added in v1.23.0 

func NewSearchUsersPaginator(client SearchUsersAPIClient, params *SearchUsersInput, optFns ...func(*SearchUsersPaginatorOptions)) *SearchUsersPaginator

NewSearchUsersPaginator returns a new SearchUsersPaginator

func (*SearchUsersPaginator) HasMorePages added in v1.23.0 

func (p *SearchUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchUsersPaginator) NextPage added in v1.23.0 

func (p *SearchUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchUsersOutput, error)

NextPage retrieves the next SearchUsers page.

type SearchUsersPaginatorOptions added in v1.23.0 

type SearchUsersPaginatorOptions 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
}

SearchUsersPaginatorOptions is the paginator options for SearchUsers

type SearchVocabulariesAPIClient added in v1.17.0 

type SearchVocabulariesAPIClient interface {
	SearchVocabularies(context.Context, *SearchVocabulariesInput, ...func(*Options)) (*SearchVocabulariesOutput, error)
}

SearchVocabulariesAPIClient is a client that implements the SearchVocabularies operation.

type SearchVocabulariesInput added in v1.17.0 

type SearchVocabulariesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The language code of the vocabulary entries. For a list of languages and their
	// corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)
	LanguageCode types.VocabularyLanguageCode

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

	// The starting pattern of the name of the vocabulary.
	NameStartsWith *string

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The current state of the custom vocabulary.
	State types.VocabularyState
	// contains filtered or unexported fields
}

type SearchVocabulariesOutput added in v1.17.0 

type SearchVocabulariesOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// The list of the available custom vocabularies.
	VocabularySummaryList []types.VocabularySummary

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

type SearchVocabulariesPaginator added in v1.17.0 

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

SearchVocabulariesPaginator is a paginator for SearchVocabularies

func NewSearchVocabulariesPaginator added in v1.17.0 

func NewSearchVocabulariesPaginator(client SearchVocabulariesAPIClient, params *SearchVocabulariesInput, optFns ...func(*SearchVocabulariesPaginatorOptions)) *SearchVocabulariesPaginator

NewSearchVocabulariesPaginator returns a new SearchVocabulariesPaginator

func (*SearchVocabulariesPaginator) HasMorePages added in v1.17.0 

func (p *SearchVocabulariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchVocabulariesPaginator) NextPage added in v1.17.0 

func (p *SearchVocabulariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchVocabulariesOutput, error)

NextPage retrieves the next SearchVocabularies page.

type SearchVocabulariesPaginatorOptions added in v1.17.0 

type SearchVocabulariesPaginatorOptions 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
}

SearchVocabulariesPaginatorOptions is the paginator options for SearchVocabularies

type SendChatIntegrationEventInput added in v1.82.0 

type SendChatIntegrationEventInput struct {

	// Chat system identifier, used in part to uniquely identify chat. This is
	// associated with the Amazon Connect instance and flow to be used to start chats.
	// For SMS, this is the phone number destination of inbound SMS messages
	// represented by an Amazon Pinpoint phone number ARN.
	//
	// This member is required.
	DestinationId *string

	// Chat integration event payload
	//
	// This member is required.
	Event *types.ChatEvent

	// External identifier of chat customer participant, used in part to uniquely
	// identify a chat. For SMS, this is the E164 phone number of the chat customer
	// participant.
	//
	// This member is required.
	SourceId *string

	// Contact properties to apply when starting a new chat. If the integration event
	// is handled with an existing chat, this is ignored.
	NewSessionDetails *types.NewSessionDetails

	// Classification of a channel. This is used in part to uniquely identify chat.
	// Valid value: ["connect:sms"]
	Subtype *string
	// contains filtered or unexported fields
}

type SendChatIntegrationEventOutput added in v1.82.0 

type SendChatIntegrationEventOutput struct {

	// Identifier of chat contact used to handle integration event. This may be null
	// if the integration event is not valid without an already existing chat contact.
	InitialContactId *string

	// Whether handling the integration event resulted in creating a new chat or
	// acting on existing chat.
	NewChatCreated *bool

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

type StartChatContactInput 

type StartChatContactInput struct {

	// The identifier of the flow for initiating the chat. To see the ContactFlowId in
	// the Amazon Connect admin website, on the navigation menu go to Routing, Contact
	// Flows. Choose the flow. On the flow page, under the name of the flow, choose
	// Show additional flow information. The ContactFlowId is the last part of the ARN,
	// shown here in bold:
	// arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
	//
	// This member is required.
	ContactFlowId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Information identifying the participant.
	//
	// This member is required.
	ParticipantDetails *types.ParticipantDetails

	// A custom key-value pair using an attribute map. The attributes are standard
	// Amazon Connect attributes. They can be accessed in flows just like any other
	// contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value
	// pairs per contact. Attribute keys can include only alphanumeric, dash, and
	// underscore characters.
	Attributes map[string]string

	// The total duration of the newly started chat session. If not specified, the
	// chat session duration defaults to 25 hour. The minimum configurable time is 60
	// minutes. The maximum configurable time is 10,080 minutes (7 days).
	ChatDurationInMinutes *int32

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// The initial message to be sent to the newly created chat. If you have a Lex bot
	// in your flow, the initial message is not delivered to the Lex bot.
	InitialMessage *types.ChatMessage

	// Enable persistent chats. For more information about enabling persistent chat,
	// and for example use cases and how to configure for them, see Enable persistent
	// chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html)
	// .
	PersistentChat *types.PersistentChat

	// The unique identifier for an Amazon Connect contact. This identifier is related
	// to the chat starting. You cannot provide data for both RelatedContactId and
	// PersistentChat.
	RelatedContactId *string

	// A set of system defined key-value pairs stored on individual contact segments
	// using an attribute map. The attributes are standard Amazon Connect attributes.
	// They can be accessed in flows. Attribute keys can include only alphanumeric, -,
	// and _. This field can be used to show channel subtype, such as connect:Guide .
	// The types application/vnd.amazonaws.connect.message.interactive and
	// application/vnd.amazonaws.connect.message.interactive.response must be present
	// in the SupportedMessagingContentTypes field of this API in order to set
	// SegmentAttributes as { "connect:Subtype": {"valueString" : "connect:Guide" }} .
	SegmentAttributes map[string]types.SegmentAttributeValue

	// The supported chat message content types. Supported types are text/plain ,
	// text/markdown , application/json ,
	// application/vnd.amazonaws.connect.message.interactive , and
	// application/vnd.amazonaws.connect.message.interactive.response . Content types
	// must always contain text/plain . You can then put any other supported type in
	// the list. For example, all the following lists are valid because they contain
	// text/plain : [text/plain, text/markdown, application/json] , [text/markdown,
	// text/plain] , [text/plain, application/json,
	// application/vnd.amazonaws.connect.message.interactive.response] . The type
	// application/vnd.amazonaws.connect.message.interactive is required to use the
	// Show view (https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html)
	// flow block.
	SupportedMessagingContentTypes []string
	// contains filtered or unexported fields
}

type StartChatContactOutput 

type StartChatContactOutput struct {

	// The identifier of this contact within the Amazon Connect instance.
	ContactId *string

	// The contactId from which a persistent chat session is started. This field is
	// populated only for persistent chats.
	ContinuedFromContactId *string

	// The identifier for a chat participant. The participantId for a chat participant
	// is the same throughout the chat lifecycle.
	ParticipantId *string

	// The token used by the chat participant to call CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html)
	// . The participant token is valid for the lifetime of a chat participant.
	ParticipantToken *string

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

type StartContactEvaluationInput added in v1.53.0 

type StartContactEvaluationInput struct {

	// The identifier of the contact in this instance of Amazon Connect.
	//
	// This member is required.
	ContactId *string

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type StartContactEvaluationOutput added in v1.53.0 

type StartContactEvaluationOutput struct {

	// The Amazon Resource Name (ARN) for the contact evaluation resource.
	//
	// This member is required.
	EvaluationArn *string

	// A unique identifier for the contact evaluation.
	//
	// This member is required.
	EvaluationId *string

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

type StartContactRecordingInput 

type StartContactRecordingInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the contact. This is the identifier of the contact associated
	// with the first interaction with the contact center.
	//
	// This member is required.
	InitialContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The person being recorded.
	//
	// This member is required.
	VoiceRecordingConfiguration *types.VoiceRecordingConfiguration
	// contains filtered or unexported fields
}

type StartContactRecordingOutput 

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

type StartContactStreamingInput added in v1.10.0 

type StartContactStreamingInput struct {

	// The streaming configuration, such as the Amazon SNS streaming endpoint.
	//
	// This member is required.
	ChatStreamingConfiguration *types.ChatStreamingConfiguration

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	//
	// This member is required.
	ClientToken *string

	// The identifier of the contact. This is the identifier of the contact associated
	// with the first interaction with the contact center.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type StartContactStreamingOutput added in v1.10.0 

type StartContactStreamingOutput struct {

	// The identifier of the streaming configuration enabled.
	//
	// This member is required.
	StreamingId *string

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

type StartOutboundVoiceContactInput 

type StartOutboundVoiceContactInput struct {

	// The identifier of the flow for the outbound call. To see the ContactFlowId in
	// the Amazon Connect admin website, on the navigation menu go to Routing, Contact
	// Flows. Choose the flow. On the flow page, under the name of the flow, choose
	// Show additional flow information. The ContactFlowId is the last part of the ARN,
	// shown here in bold:
	// arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
	//
	// This member is required.
	ContactFlowId *string

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

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Configuration of the answering machine detection for this outbound call.
	AnswerMachineDetectionConfig *types.AnswerMachineDetectionConfig

	// A custom key-value pair using an attribute map. The attributes are standard
	// Amazon Connect attributes, and can be accessed in flows just like any other
	// contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value
	// pairs per contact. Attribute keys can include only alphanumeric, dash, and
	// underscore characters.
	Attributes map[string]string

	// The campaign identifier of the outbound communication.
	CampaignId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// . The token is valid for 7 days after creation. If a contact is already started,
	// the contact ID is returned.
	ClientToken *string

	// A description of the voice contact that is shown to an agent in the Contact
	// Control Panel (CCP).
	Description *string

	// The name of a voice contact that is shown to an agent in the Contact Control
	// Panel (CCP).
	Name *string

	// 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 flow is used. If you do not specify a queue, you must
	// specify a source phone number.
	QueueId *string

	// A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
	// Contacts can have the following reference types at the time of creation: URL |
	// NUMBER | STRING | DATE | EMAIL . ATTACHMENT is not a supported reference type
	// during voice contact creation.
	References map[string]types.Reference

	// The contactId that is related to this contact. Linking voice, task, or chat by
	// using RelatedContactID copies over contact attributes from the related contact
	// to the new contact. All updates to user-defined attributes in the new contact
	// are limited to the individual contact ID. There are no limits to the number of
	// contacts that can be linked by using RelatedContactId .
	RelatedContactId *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.
	SourcePhoneNumber *string

	// Denotes the class of traffic. Calls with different traffic types are handled
	// differently by Amazon Connect. The default value is GENERAL . Use CAMPAIGN if
	// EnableAnswerMachineDetection is set to true . For all other cases, use GENERAL .
	TrafficType types.TrafficType
	// contains filtered or unexported fields
}

type StartOutboundVoiceContactOutput 

type StartOutboundVoiceContactOutput struct {

	// The identifier of this contact within the Amazon Connect instance.
	ContactId *string

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

type StartTaskContactInput added in v0.31.0 

type StartTaskContactInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of a task that is shown to an agent in the Contact Control Panel (CCP).
	//
	// This member is required.
	Name *string

	// A custom key-value pair using an attribute map. The attributes are standard
	// Amazon Connect attributes, and can be accessed in flows just like any other
	// contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value
	// pairs per contact. Attribute keys can include only alphanumeric, dash, and
	// underscore characters.
	Attributes map[string]string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// The identifier of the flow for initiating the tasks. To see the ContactFlowId
	// in the Amazon Connect admin website, on the navigation menu go to Routing,
	// Contact Flows. Choose the flow. On the flow page, under the name of the flow,
	// choose Show additional flow information. The ContactFlowId is the last part of
	// the ARN, shown here in bold:
	// arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
	ContactFlowId *string

	// A description of the task that is shown to an agent in the Contact Control
	// Panel (CCP).
	Description *string

	// The identifier of the previous chat, voice, or task contact. Any updates to
	// user-defined attributes to task contacts linked using the same PreviousContactID
	// will affect every contact in the chain. There can be a maximum of 12 linked task
	// contacts in a chain.
	PreviousContactId *string

	// The identifier for the quick connect. Tasks that are created by using
	// QuickConnectId will use the flow that is defined on agent or queue quick
	// connect. For more information about quick connects, see Create quick connects (https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html)
	// .
	QuickConnectId *string

	// A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
	// Tasks can have the following reference types at the time of creation: URL |
	// NUMBER | STRING | DATE | EMAIL . ATTACHMENT is not a supported reference type
	// during task creation.
	References map[string]types.Reference

	// The contactId that is related (https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks)
	// to this contact. Linking tasks together by using RelatedContactID copies over
	// contact attributes from the related task contact to the new task contact. All
	// updates to user-defined attributes in the new task contact are limited to the
	// individual contact ID, unlike what happens when tasks are linked by using
	// PreviousContactID . There are no limits to the number of contacts that can be
	// linked by using RelatedContactId .
	RelatedContactId *string

	// The timestamp, in Unix Epoch seconds format, at which to start running the
	// inbound flow. The scheduled time cannot be in the past. It must be within up to
	// 6 days in future.
	ScheduledTime *time.Time

	// A unique identifier for the task template. For more information about task
	// templates, see Create task templates (https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html)
	// in the Amazon Connect Administrator Guide.
	TaskTemplateId *string
	// contains filtered or unexported fields
}

type StartTaskContactOutput added in v0.31.0 

type StartTaskContactOutput struct {

	// The identifier of this contact within the Amazon Connect instance.
	ContactId *string

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

type StartWebRTCContactInput added in v1.82.0 

type StartWebRTCContactInput struct {

	// The identifier of the flow for the call. To see the ContactFlowId in the Amazon
	// Connect admin website, on the navigation menu go to Routing, Contact Flows.
	// Choose the flow. On the flow page, under the name of the flow, choose Show
	// additional flow information. The ContactFlowId is the last part of the ARN,
	// shown here in bold:
	// arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
	//
	// This member is required.
	ContactFlowId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The customer's details.
	//
	// This member is required.
	ParticipantDetails *types.ParticipantDetails

	// Information about the video sharing capabilities of the participants (customer,
	// agent).
	AllowedCapabilities *types.AllowedCapabilities

	// A custom key-value pair using an attribute map. The attributes are standard
	// Amazon Connect attributes, and can be accessed in flows just like any other
	// contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value
	// pairs per contact. Attribute keys can include only alphanumeric, -, and _
	// characters.
	Attributes map[string]string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// . The token is valid for 7 days after creation. If a contact is already started,
	// the contact ID is returned.
	ClientToken *string

	// A description of the task that is shown to an agent in the Contact Control
	// Panel (CCP).
	Description *string

	// A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
	// Tasks can have the following reference types at the time of creation: URL |
	// NUMBER | STRING | DATE | EMAIL . ATTACHMENT is not a supported reference type
	// during task creation.
	References map[string]types.Reference

	// The unique identifier for an Amazon Connect contact. This identifier is related
	// to the contact starting.
	RelatedContactId *string
	// contains filtered or unexported fields
}

type StartWebRTCContactOutput added in v1.82.0 

type StartWebRTCContactOutput struct {

	// Information required for the client application (mobile application or website)
	// to connect to the call.
	ConnectionData *types.ConnectionData

	// The identifier of the contact in this instance of Amazon Connect.
	ContactId *string

	// The identifier for a contact participant. The ParticipantId for a contact
	// participant is the same throughout the contact lifecycle.
	ParticipantId *string

	// The token used by the contact participant to call the
	// CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html)
	// API. The participant token is valid for the lifetime of a contact participant.
	ParticipantToken *string

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

type StopContactInput 

type StopContactInput struct {

	// The ID of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The reason a contact can be disconnected. Only Amazon Connect outbound
	// campaigns can provide this field.
	DisconnectReason *types.DisconnectReason
	// contains filtered or unexported fields
}

type StopContactOutput 

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

type StopContactRecordingInput 

type StopContactRecordingInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the contact. This is the identifier of the contact associated
	// with the first interaction with the contact center.
	//
	// This member is required.
	InitialContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type StopContactRecordingOutput 

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

type StopContactStreamingInput added in v1.10.0 

type StopContactStreamingInput struct {

	// The identifier of the contact. This is the identifier of the contact that is
	// associated with the first interaction with the contact center.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the streaming configuration enabled.
	//
	// This member is required.
	StreamingId *string
	// contains filtered or unexported fields
}

type StopContactStreamingOutput added in v1.10.0 

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

type SubmitContactEvaluationInput added in v1.53.0 

type SubmitContactEvaluationInput struct {

	// A unique identifier for the contact evaluation.
	//
	// This member is required.
	EvaluationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A map of question identifiers to answer value.
	Answers map[string]types.EvaluationAnswerInput

	// A map of question identifiers to note value.
	Notes map[string]types.EvaluationNote
	// contains filtered or unexported fields
}

type SubmitContactEvaluationOutput added in v1.53.0 

type SubmitContactEvaluationOutput struct {

	// The Amazon Resource Name (ARN) for the contact evaluation resource.
	//
	// This member is required.
	EvaluationArn *string

	// A unique identifier for the contact evaluation.
	//
	// This member is required.
	EvaluationId *string

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

type SuspendContactRecordingInput 

type SuspendContactRecordingInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the contact. This is the identifier of the contact associated
	// with the first interaction with the contact center.
	//
	// This member is required.
	InitialContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type SuspendContactRecordingOutput 

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

type TagContactInput added in v1.85.0 

type TagContactInput struct {

	// The identifier of the contact in this instance of Amazon Connect.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The tags to be assigned to the contact resource. For example, { "Tags":
	// {"key1":"value1", "key2":"value2"} }. Authorization is not supported by this
	// tag.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagContactOutput added in v1.85.0 

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

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// The tags used to organize, track, or control access for this resource. For
	// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

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

type TransferContactInput added in v1.25.0 

type TransferContactInput struct {

	// The identifier of the flow.
	//
	// This member is required.
	ContactFlowId *string

	// The identifier of the contact in this instance of Amazon Connect.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// The identifier for the queue.
	QueueId *string

	// The identifier for the user. This can be the ID or the ARN of the user.
	UserId *string
	// contains filtered or unexported fields
}

type TransferContactOutput added in v1.25.0 

type TransferContactOutput struct {

	// The Amazon Resource Name (ARN) of the contact.
	ContactArn *string

	// The identifier of the contact in this instance of Amazon Connect.
	ContactId *string

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

type UntagContactInput added in v1.85.0 

type UntagContactInput struct {

	// The identifier of the contact in this instance of Amazon Connect.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A list of tag keys. Existing tags on the contact whose keys are members of this
	// list will be removed.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagContactOutput added in v1.85.0 

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

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

type UntagResourceOutput 

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

type UpdateAgentStatusInput added in v1.6.0 

type UpdateAgentStatusInput struct {

	// The identifier of the agent status.
	//
	// This member is required.
	AgentStatusId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The description of the agent status.
	Description *string

	// The display order of the agent status.
	DisplayOrder *int32

	// The name of the agent status.
	Name *string

	// A number indicating the reset order of the agent status.
	ResetOrderNumber bool

	// The state of the agent status.
	State types.AgentStatusState
	// contains filtered or unexported fields
}

type UpdateAgentStatusOutput added in v1.6.0 

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

type UpdateContactAttributesInput 

type UpdateContactAttributesInput struct {

	// The Amazon Connect attributes. These attributes can be accessed in flows just
	// like any other contact attributes. You can have up to 32,768 UTF-8 bytes across
	// all attributes for a contact. Attribute keys can include only alphanumeric,
	// dash, and underscore characters.
	//
	// This member is required.
	Attributes map[string]string

	// The identifier of the contact. This is the identifier of the contact associated
	// with the first interaction with the contact center.
	//
	// This member is required.
	InitialContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type UpdateContactAttributesOutput 

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

type UpdateContactEvaluationInput added in v1.53.0 

type UpdateContactEvaluationInput struct {

	// A unique identifier for the contact evaluation.
	//
	// This member is required.
	EvaluationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A map of question identifiers to answer value.
	Answers map[string]types.EvaluationAnswerInput

	// A map of question identifiers to note value.
	Notes map[string]types.EvaluationNote
	// contains filtered or unexported fields
}

type UpdateContactEvaluationOutput added in v1.53.0 

type UpdateContactEvaluationOutput struct {

	// The Amazon Resource Name (ARN) for the contact evaluation resource.
	//
	// This member is required.
	EvaluationArn *string

	// A unique identifier for the contact evaluation.
	//
	// This member is required.
	EvaluationId *string

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

type UpdateContactFlowContentInput added in v0.29.0 

type UpdateContactFlowContentInput struct {

	// The identifier of the flow.
	//
	// This member is required.
	ContactFlowId *string

	// The JSON string that represents the content of the flow. For an example, see
	// Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html)
	// . Length Constraints: Minimum length of 1. Maximum length of 256000.
	//
	// This member is required.
	Content *string

	// The identifier of the Amazon Connect instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type UpdateContactFlowContentOutput added in v0.29.0 

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

type UpdateContactFlowMetadataInput added in v1.13.0 

type UpdateContactFlowMetadataInput struct {

	// The identifier of the flow.
	//
	// This member is required.
	ContactFlowId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The state of flow.
	ContactFlowState types.ContactFlowState

	// The description of the flow.
	Description *string

	// The name of the flow.
	Name *string
	// contains filtered or unexported fields
}

type UpdateContactFlowMetadataOutput added in v1.13.0 

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

type UpdateContactFlowModuleContentInput added in v1.13.0 

type UpdateContactFlowModuleContentInput struct {

	// The identifier of the flow module.
	//
	// This member is required.
	ContactFlowModuleId *string

	// The JSON string that represents the content of the flow. For an example, see
	// Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html)
	// .
	//
	// This member is required.
	Content *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type UpdateContactFlowModuleContentOutput added in v1.13.0 

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

type UpdateContactFlowModuleMetadataInput added in v1.13.0 

type UpdateContactFlowModuleMetadataInput struct {

	// The identifier of the flow module.
	//
	// This member is required.
	ContactFlowModuleId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The description of the flow module.
	Description *string

	// The name of the flow module.
	Name *string

	// The state of flow module.
	State types.ContactFlowModuleState
	// contains filtered or unexported fields
}

type UpdateContactFlowModuleMetadataOutput added in v1.13.0 

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

type UpdateContactFlowNameInput added in v0.29.0 

type UpdateContactFlowNameInput struct {

	// The identifier of the flow.
	//
	// This member is required.
	ContactFlowId *string

	// The identifier of the Amazon Connect instance.
	//
	// This member is required.
	InstanceId *string

	// The description of the flow.
	Description *string

	// The name of the flow.
	Name *string
	// contains filtered or unexported fields
}

type UpdateContactFlowNameOutput added in v0.29.0 

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

type UpdateContactInput added in v1.12.0 

type UpdateContactInput struct {

	// The identifier of the contact. This is the identifier of the contact associated
	// with the first interaction with your contact center.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The description of the contact.
	Description *string

	// The name of the contact.
	Name *string

	// Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
	References map[string]types.Reference
	// contains filtered or unexported fields
}

type UpdateContactOutput added in v1.12.0 

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

type UpdateContactRoutingDataInput added in v1.87.0 

type UpdateContactRoutingDataInput struct {

	// The identifier of the contact in this instance of Amazon Connect.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Priority of the contact in the queue. The default priority for new contacts is
	// 5. You can raise the priority of a contact compared to other contacts in the
	// queue by assigning them a higher priority, such as 1 or 2.
	QueuePriority *int64

	// The number of seconds to add or subtract from the contact's routing age.
	// Contacts are routed to agents on a first-come, first-serve basis. This means
	// that changing their amount of time in queue compared to others also changes
	// their position in queue.
	QueueTimeAdjustmentSeconds *int32
	// contains filtered or unexported fields
}

type UpdateContactRoutingDataOutput added in v1.87.0 

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

type UpdateContactScheduleInput added in v1.12.0 

type UpdateContactScheduleInput struct {

	// The identifier of the contact.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The timestamp, in Unix Epoch seconds format, at which to start running the
	// inbound flow. The scheduled time cannot be in the past. It must be within up to
	// 6 days in future.
	//
	// This member is required.
	ScheduledTime *time.Time
	// contains filtered or unexported fields
}

type UpdateContactScheduleOutput added in v1.12.0 

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

type UpdateEvaluationFormInput added in v1.53.0 

type UpdateEvaluationFormInput struct {

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

	// A version of the evaluation form to update.
	//
	// This member is required.
	EvaluationFormVersion int32

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Items that are part of the evaluation form. The total number of sections and
	// questions must not exceed 100 each. Questions must be contained in a section.
	//
	// This member is required.
	Items []types.EvaluationFormItem

	// A title of the evaluation form.
	//
	// This member is required.
	Title *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// A flag indicating whether the operation must create a new version.
	CreateNewVersion *bool

	// The description of the evaluation form.
	Description *string

	// A scoring strategy of the evaluation form.
	ScoringStrategy *types.EvaluationFormScoringStrategy
	// contains filtered or unexported fields
}

type UpdateEvaluationFormOutput added in v1.53.0 

type UpdateEvaluationFormOutput struct {

	// The Amazon Resource Name (ARN) for the contact evaluation resource.
	//
	// This member is required.
	EvaluationFormArn *string

	// The unique identifier for the evaluation form.
	//
	// This member is required.
	EvaluationFormId *string

	// The version of the updated evaluation form resource.
	//
	// This member is required.
	EvaluationFormVersion int32

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

type UpdateHoursOfOperationInput added in v1.6.0 

type UpdateHoursOfOperationInput struct {

	// The identifier of the hours of operation.
	//
	// This member is required.
	HoursOfOperationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Configuration information of the hours of operation.
	Config []types.HoursOfOperationConfig

	// The description of the hours of operation.
	Description *string

	// The name of the hours of operation.
	Name *string

	// The time zone of the hours of operation.
	TimeZone *string
	// contains filtered or unexported fields
}

type UpdateHoursOfOperationOutput added in v1.6.0 

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

type UpdateInstanceAttributeInput added in v0.30.0 

type UpdateInstanceAttributeInput struct {

	// The type of attribute. Only allowlisted customers can consume
	// USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services
	// Support for allowlisting.
	//
	// This member is required.
	AttributeType types.InstanceAttributeType

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The value for the attribute. Maximum character limit is 100.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

type UpdateInstanceAttributeOutput added in v0.30.0 

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

type UpdateInstanceStorageConfigInput added in v0.30.0 

type UpdateInstanceStorageConfigInput struct {

	// The existing association identifier that uniquely identifies the resource type
	// and storage config for the given instance ID.
	//
	// This member is required.
	AssociationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A valid resource type.
	//
	// This member is required.
	ResourceType types.InstanceStorageResourceType

	// The storage configuration for the instance.
	//
	// This member is required.
	StorageConfig *types.InstanceStorageConfig
	// contains filtered or unexported fields
}

type UpdateInstanceStorageConfigOutput added in v0.30.0 

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

type UpdateParticipantRoleConfigInput added in v1.41.0 

type UpdateParticipantRoleConfigInput struct {

	// The Amazon Connect channel you want to configure.
	//
	// This member is required.
	ChannelConfiguration types.UpdateParticipantRoleConfigChannelInfo

	// The identifier of the contact in this instance of Amazon Connect.
	//
	// This member is required.
	ContactId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type UpdateParticipantRoleConfigOutput added in v1.41.0 

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

type UpdatePhoneNumberInput added in v1.22.0 

type UpdatePhoneNumberInput struct {

	// A unique identifier for the phone number.
	//
	// This member is required.
	PhoneNumberId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// The identifier of the Amazon Connect instance that phone numbers are claimed
	// to. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or
	// TargetArn .
	InstanceId *string

	// The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
	// distribution groups that phone number inbound traffic is routed through. You
	// must enter InstanceId or TargetArn .
	TargetArn *string
	// contains filtered or unexported fields
}

type UpdatePhoneNumberMetadataInput added in v1.70.0 

type UpdatePhoneNumberMetadataInput struct {

	// The Amazon Resource Name (ARN) or resource ID of the phone number.
	//
	// This member is required.
	PhoneNumberId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
	// .
	ClientToken *string

	// The description of the phone number.
	PhoneNumberDescription *string
	// contains filtered or unexported fields
}

type UpdatePhoneNumberMetadataOutput added in v1.70.0 

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

type UpdatePhoneNumberOutput added in v1.22.0 

type UpdatePhoneNumberOutput struct {

	// The Amazon Resource Name (ARN) of the phone number.
	PhoneNumberArn *string

	// A unique identifier for the phone number.
	PhoneNumberId *string

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

type UpdatePredefinedAttributeInput added in v1.87.0 

type UpdatePredefinedAttributeInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the predefined attribute.
	//
	// This member is required.
	Name *string

	// The values of the predefined attribute.
	Values types.PredefinedAttributeValues
	// contains filtered or unexported fields
}

type UpdatePredefinedAttributeOutput added in v1.87.0 

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

type UpdatePromptInput added in v1.55.0 

type UpdatePromptInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the prompt.
	//
	// This member is required.
	PromptId *string

	// A description of the prompt.
	Description *string

	// The name of the prompt.
	Name *string

	// The URI for the S3 bucket where the prompt is stored. You can provide S3
	// pre-signed URLs returned by the GetPromptFile (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html)
	// API instead of providing S3 URIs.
	S3Uri *string
	// contains filtered or unexported fields
}

type UpdatePromptOutput added in v1.55.0 

type UpdatePromptOutput struct {

	// The Amazon Resource Name (ARN) of the prompt.
	PromptARN *string

	// A unique identifier for the prompt.
	PromptId *string

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

type UpdateQueueHoursOfOperationInput added in v1.2.0 

type UpdateQueueHoursOfOperationInput struct {

	// The identifier for the hours of operation.
	//
	// This member is required.
	HoursOfOperationId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type UpdateQueueHoursOfOperationOutput added in v1.2.0 

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

type UpdateQueueMaxContactsInput added in v1.2.0 

type UpdateQueueMaxContactsInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string

	// The maximum number of contacts that can be in the queue before it is considered
	// full.
	MaxContacts *int32
	// contains filtered or unexported fields
}

type UpdateQueueMaxContactsOutput added in v1.2.0 

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

type UpdateQueueNameInput added in v1.2.0 

type UpdateQueueNameInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string

	// The description of the queue.
	Description *string

	// The name of the queue.
	Name *string
	// contains filtered or unexported fields
}

type UpdateQueueNameOutput added in v1.2.0 

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

type UpdateQueueOutboundCallerConfigInput added in v1.2.0 

type UpdateQueueOutboundCallerConfigInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The outbound caller ID name, number, and outbound whisper flow.
	//
	// This member is required.
	OutboundCallerConfig *types.OutboundCallerConfig

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type UpdateQueueOutboundCallerConfigOutput added in v1.2.0 

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

type UpdateQueueStatusInput added in v1.2.0 

type UpdateQueueStatusInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the queue.
	//
	// This member is required.
	QueueId *string

	// The status of the queue.
	//
	// This member is required.
	Status types.QueueStatus
	// contains filtered or unexported fields
}

type UpdateQueueStatusOutput added in v1.2.0 

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

type UpdateQuickConnectConfigInput added in v0.31.0 

type UpdateQuickConnectConfigInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Information about the configuration settings for the quick connect.
	//
	// This member is required.
	QuickConnectConfig *types.QuickConnectConfig

	// The identifier for the quick connect.
	//
	// This member is required.
	QuickConnectId *string
	// contains filtered or unexported fields
}

type UpdateQuickConnectConfigOutput added in v0.31.0 

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

type UpdateQuickConnectNameInput added in v0.31.0 

type UpdateQuickConnectNameInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the quick connect.
	//
	// This member is required.
	QuickConnectId *string

	// The description of the quick connect.
	Description *string

	// The name of the quick connect.
	Name *string
	// contains filtered or unexported fields
}

type UpdateQuickConnectNameOutput added in v0.31.0 

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

type UpdateRoutingProfileAgentAvailabilityTimerInput added in v1.64.0 

type UpdateRoutingProfileAgentAvailabilityTimerInput struct {

	// Whether agents with this routing profile will have their routing order
	// calculated based on time since their last inbound contact or longest idle time.
	//
	// This member is required.
	AgentAvailabilityTimer types.AgentAvailabilityTimer

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string
	// contains filtered or unexported fields
}

type UpdateRoutingProfileAgentAvailabilityTimerOutput added in v1.64.0 

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

type UpdateRoutingProfileConcurrencyInput added in v0.29.0 

type UpdateRoutingProfileConcurrencyInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The channels that agents can handle in the Contact Control Panel (CCP).
	//
	// This member is required.
	MediaConcurrencies []types.MediaConcurrency

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string
	// contains filtered or unexported fields
}

type UpdateRoutingProfileConcurrencyOutput added in v0.29.0 

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

type UpdateRoutingProfileDefaultOutboundQueueInput added in v0.29.0 

type UpdateRoutingProfileDefaultOutboundQueueInput struct {

	// The identifier for the default outbound queue.
	//
	// This member is required.
	DefaultOutboundQueueId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string
	// contains filtered or unexported fields
}

type UpdateRoutingProfileDefaultOutboundQueueOutput added in v0.29.0 

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

type UpdateRoutingProfileNameInput added in v0.29.0 

type UpdateRoutingProfileNameInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string

	// The description of the routing profile. Must not be more than 250 characters.
	Description *string

	// The name of the routing profile. Must not be more than 127 characters.
	Name *string
	// contains filtered or unexported fields
}

type UpdateRoutingProfileNameOutput added in v0.29.0 

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

type UpdateRoutingProfileQueuesInput added in v0.29.0 

type UpdateRoutingProfileQueuesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The queues to be updated for this routing profile. Queues must first be
	// associated to the routing profile. You can do this using
	// AssociateRoutingProfileQueues.
	//
	// This member is required.
	QueueConfigs []types.RoutingProfileQueueConfig

	// The identifier of the routing profile.
	//
	// This member is required.
	RoutingProfileId *string
	// contains filtered or unexported fields
}

type UpdateRoutingProfileQueuesOutput added in v0.29.0 

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

type UpdateRuleInput added in v1.39.0 

type UpdateRuleInput struct {

	// A list of actions to be run when the rule is triggered.
	//
	// This member is required.
	Actions []types.RuleAction

	// The conditions of the rule.
	//
	// This member is required.
	Function *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the rule. You can change the name only if TriggerEventSource is one
	// of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
	// OnSalesforceCaseCreate
	//
	// This member is required.
	Name *string

	// The publish status of the rule.
	//
	// This member is required.
	PublishStatus types.RulePublishStatus

	// A unique identifier for the rule.
	//
	// This member is required.
	RuleId *string
	// contains filtered or unexported fields
}

type UpdateRuleOutput added in v1.39.0 

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

type UpdateSecurityProfileInput added in v1.11.0 

type UpdateSecurityProfileInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier for the security profle.
	//
	// This member is required.
	SecurityProfileId *string

	// The identifier of the hierarchy group that a security profile uses to restrict
	// access to resources in Amazon Connect.
	AllowedAccessControlHierarchyGroupId *string

	// The list of tags that a security profile uses to restrict access to resources
	// in Amazon Connect.
	AllowedAccessControlTags map[string]string

	// A list of the third-party application's metadata.
	Applications []types.Application

	// The description of the security profile.
	Description *string

	// The list of resources that a security profile applies hierarchy restrictions to
	// in Amazon Connect. Following are acceptable ResourceNames: User .
	HierarchyRestrictedResources []string

	// The permissions granted to a security profile. For a list of valid permissions,
	// see List of security profile permissions (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html)
	// .
	Permissions []string

	// The list of resources that a security profile applies tag restrictions to in
	// Amazon Connect.
	TagRestrictedResources []string
	// contains filtered or unexported fields
}

type UpdateSecurityProfileOutput added in v1.11.0 

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

type UpdateTaskTemplateInput added in v1.25.0 

type UpdateTaskTemplateInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// A unique identifier for the task template.
	//
	// This member is required.
	TaskTemplateId *string

	// Constraints that are applicable to the fields listed.
	Constraints *types.TaskTemplateConstraints

	// The identifier of the flow that runs by default when a task is created by
	// referencing this template.
	ContactFlowId *string

	// The default values for fields when a task is created by referencing this
	// template.
	Defaults *types.TaskTemplateDefaults

	// The description of the task template.
	Description *string

	// Fields that are part of the template.
	Fields []types.TaskTemplateField

	// The name of the task template.
	Name *string

	// Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
	// only be created from ACTIVE templates. If a template is marked as INACTIVE ,
	// then a task that refers to this template cannot be created.
	Status types.TaskTemplateStatus
	// contains filtered or unexported fields
}

type UpdateTaskTemplateOutput added in v1.25.0 

type UpdateTaskTemplateOutput struct {

	// The Amazon Resource Name (ARN) for the task template resource.
	Arn *string

	// Constraints that are applicable to the fields listed.
	Constraints *types.TaskTemplateConstraints

	// The identifier of the flow that runs by default when a task is created by
	// referencing this template.
	ContactFlowId *string

	// The timestamp when the task template was created.
	CreatedTime *time.Time

	// The default values for fields when a task is created by referencing this
	// template.
	Defaults *types.TaskTemplateDefaults

	// The description of the task template.
	Description *string

	// Fields that are part of the template.
	Fields []types.TaskTemplateField

	// The identifier of the task template resource.
	Id *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	InstanceId *string

	// The timestamp when the task template was last modified.
	LastModifiedTime *time.Time

	// The name of the task template.
	Name *string

	// Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
	// only be created from ACTIVE templates. If a template is marked as INACTIVE ,
	// then a task that refers to this template cannot be created.
	Status types.TaskTemplateStatus

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

type UpdateTrafficDistributionInput added in v1.33.0 

type UpdateTrafficDistributionInput struct {

	// The identifier of the traffic distribution group. This can be the ID or the ARN
	// if the API is being called in the Region where the traffic distribution group
	// was created. The ARN must be provided if the call is from the replicated Region.
	//
	// This member is required.
	Id *string

	// The distribution of agents between the instance and its replica(s).
	AgentConfig *types.AgentConfig

	// The distribution that determines which Amazon Web Services Regions should be
	// used to sign in agents in to both the instance and its replica(s).
	SignInConfig *types.SignInConfig

	// The distribution of traffic between the instance and its replica(s).
	TelephonyConfig *types.TelephonyConfig
	// contains filtered or unexported fields
}

type UpdateTrafficDistributionOutput added in v1.33.0 

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

type UpdateUserHierarchyGroupNameInput added in v0.30.0 

type UpdateUserHierarchyGroupNameInput struct {

	// The identifier of the hierarchy group.
	//
	// This member is required.
	HierarchyGroupId *string

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The name of the hierarchy group. Must not be more than 100 characters.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type UpdateUserHierarchyGroupNameOutput added in v0.30.0 

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

type UpdateUserHierarchyInput 

type UpdateUserHierarchyInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string

	// The identifier of the hierarchy group.
	HierarchyGroupId *string
	// contains filtered or unexported fields
}

type UpdateUserHierarchyOutput 

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

type UpdateUserHierarchyStructureInput added in v0.30.0 

type UpdateUserHierarchyStructureInput struct {

	// The hierarchy levels to update.
	//
	// This member is required.
	HierarchyStructure *types.HierarchyStructureUpdate

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type UpdateUserHierarchyStructureOutput added in v0.30.0 

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

type UpdateUserIdentityInfoInput 

type UpdateUserIdentityInfoInput struct {

	// The identity information for the user.
	//
	// This member is required.
	IdentityInfo *types.UserIdentityInfo

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type UpdateUserIdentityInfoOutput 

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

type UpdateUserPhoneConfigInput 

type UpdateUserPhoneConfigInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// Information about phone configuration settings for the user.
	//
	// This member is required.
	PhoneConfig *types.UserPhoneConfig

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type UpdateUserPhoneConfigOutput 

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

type UpdateUserProficienciesInput added in v1.87.0 

type UpdateUserProficienciesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID in
	// the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string

	// The proficiencies to be updated for the user. Proficiencies must first be
	// associated to the user. You can do this using AssociateUserProficiencies API.
	//
	// This member is required.
	UserProficiencies []types.UserProficiency
	// contains filtered or unexported fields
}

type UpdateUserProficienciesOutput added in v1.87.0 

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

type UpdateUserRoutingProfileInput 

type UpdateUserRoutingProfileInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the routing profile for the user.
	//
	// This member is required.
	RoutingProfileId *string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type UpdateUserRoutingProfileOutput 

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

type UpdateUserSecurityProfilesInput 

type UpdateUserSecurityProfilesInput struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifiers of the security profiles for the user.
	//
	// This member is required.
	SecurityProfileIds []string

	// The identifier of the user account.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type UpdateUserSecurityProfilesOutput 

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

type UpdateViewContentInput added in v1.66.0 

type UpdateViewContentInput struct {

	// View content containing all content necessary to render a view except for
	// runtime input data and the runtime input schema, which is auto-generated by this
	// operation. The total uncompressed content has a maximum file size of 400kB.
	//
	// This member is required.
	Content *types.ViewInputContent

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status
	// will initiate validation on the content.
	//
	// This member is required.
	Status types.ViewStatus

	// The identifier of the view. Both ViewArn and ViewId can be used.
	//
	// This member is required.
	ViewId *string
	// contains filtered or unexported fields
}

type UpdateViewContentOutput added in v1.66.0 

type UpdateViewContentOutput struct {

	// A view resource object. Contains metadata and content necessary to render the
	// view.
	View *types.View

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

type UpdateViewMetadataInput added in v1.66.0 

type UpdateViewMetadataInput struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	//
	// This member is required.
	InstanceId *string

	// The identifier of the view. Both ViewArn and ViewId can be used.
	//
	// This member is required.
	ViewId *string

	// The description of the view.
	Description *string

	// The name of the view.
	Name *string
	// contains filtered or unexported fields
}

type UpdateViewMetadataOutput added in v1.66.0 

type UpdateViewMetadataOutput 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.