connect

package
v1.16.9-custom-go-mod Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package connect provides the client and types for making API requests to Amazon Connect Service.

The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Throttling limits for the Amazon Connect API operations:

For the GetMetricData and GetCurrentMetricData operations, a RateLimit of 5 per second, and a BurstLimit of 8 per second.

For all other operations, a RateLimit of 2 per second, and a BurstLimit of 5 per second.

You can request an increase to the throttling limits by submitting a Amazon Connect service limits increase form (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase). You must be signed in to your AWS account to access the form.

See https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08 for more information on this service.

See connect package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/connect/

Using the Client

To contact Amazon Connect Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Connect Service client Connect for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/connect/#New

Index

Constants

View Source 
const (
	// CurrentMetricNameAgentsOnline is a CurrentMetricName enum value
	CurrentMetricNameAgentsOnline = "AGENTS_ONLINE"

	// CurrentMetricNameAgentsAvailable is a CurrentMetricName enum value
	CurrentMetricNameAgentsAvailable = "AGENTS_AVAILABLE"

	// CurrentMetricNameAgentsOnCall is a CurrentMetricName enum value
	CurrentMetricNameAgentsOnCall = "AGENTS_ON_CALL"

	// CurrentMetricNameAgentsNonProductive is a CurrentMetricName enum value
	CurrentMetricNameAgentsNonProductive = "AGENTS_NON_PRODUCTIVE"

	// CurrentMetricNameAgentsAfterContactWork is a CurrentMetricName enum value
	CurrentMetricNameAgentsAfterContactWork = "AGENTS_AFTER_CONTACT_WORK"

	// CurrentMetricNameAgentsError is a CurrentMetricName enum value
	CurrentMetricNameAgentsError = "AGENTS_ERROR"

	// CurrentMetricNameAgentsStaffed is a CurrentMetricName enum value
	CurrentMetricNameAgentsStaffed = "AGENTS_STAFFED"

	// CurrentMetricNameContactsInQueue is a CurrentMetricName enum value
	CurrentMetricNameContactsInQueue = "CONTACTS_IN_QUEUE"

	// CurrentMetricNameOldestContactAge is a CurrentMetricName enum value
	CurrentMetricNameOldestContactAge = "OLDEST_CONTACT_AGE"

	// CurrentMetricNameContactsScheduled is a CurrentMetricName enum value
	CurrentMetricNameContactsScheduled = "CONTACTS_SCHEDULED"
)

A list of current metric names.

View Source 
const (
	// GroupingQueue is a Grouping enum value
	GroupingQueue = "QUEUE"

	// GroupingChannel is a Grouping enum value
	GroupingChannel = "CHANNEL"
)
View Source 
const (
	// HistoricalMetricNameContactsQueued is a HistoricalMetricName enum value
	HistoricalMetricNameContactsQueued = "CONTACTS_QUEUED"

	// HistoricalMetricNameContactsHandled is a HistoricalMetricName enum value
	HistoricalMetricNameContactsHandled = "CONTACTS_HANDLED"

	// HistoricalMetricNameContactsAbandoned is a HistoricalMetricName enum value
	HistoricalMetricNameContactsAbandoned = "CONTACTS_ABANDONED"

	// HistoricalMetricNameContactsConsulted is a HistoricalMetricName enum value
	HistoricalMetricNameContactsConsulted = "CONTACTS_CONSULTED"

	// HistoricalMetricNameContactsAgentHungUpFirst is a HistoricalMetricName enum value
	HistoricalMetricNameContactsAgentHungUpFirst = "CONTACTS_AGENT_HUNG_UP_FIRST"

	// HistoricalMetricNameContactsHandledIncoming is a HistoricalMetricName enum value
	HistoricalMetricNameContactsHandledIncoming = "CONTACTS_HANDLED_INCOMING"

	// HistoricalMetricNameContactsHandledOutbound is a HistoricalMetricName enum value
	HistoricalMetricNameContactsHandledOutbound = "CONTACTS_HANDLED_OUTBOUND"

	// HistoricalMetricNameContactsHoldAbandons is a HistoricalMetricName enum value
	HistoricalMetricNameContactsHoldAbandons = "CONTACTS_HOLD_ABANDONS"

	// HistoricalMetricNameContactsTransferredIn is a HistoricalMetricName enum value
	HistoricalMetricNameContactsTransferredIn = "CONTACTS_TRANSFERRED_IN"

	// HistoricalMetricNameContactsTransferredOut is a HistoricalMetricName enum value
	HistoricalMetricNameContactsTransferredOut = "CONTACTS_TRANSFERRED_OUT"

	// HistoricalMetricNameContactsTransferredInFromQueue is a HistoricalMetricName enum value
	HistoricalMetricNameContactsTransferredInFromQueue = "CONTACTS_TRANSFERRED_IN_FROM_QUEUE"

	// HistoricalMetricNameContactsTransferredOutFromQueue is a HistoricalMetricName enum value
	HistoricalMetricNameContactsTransferredOutFromQueue = "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE"

	// HistoricalMetricNameContactsMissed is a HistoricalMetricName enum value
	HistoricalMetricNameContactsMissed = "CONTACTS_MISSED"

	// HistoricalMetricNameCallbackContactsHandled is a HistoricalMetricName enum value
	HistoricalMetricNameCallbackContactsHandled = "CALLBACK_CONTACTS_HANDLED"

	// HistoricalMetricNameApiContactsHandled is a HistoricalMetricName enum value
	HistoricalMetricNameApiContactsHandled = "API_CONTACTS_HANDLED"

	// HistoricalMetricNameOccupancy is a HistoricalMetricName enum value
	HistoricalMetricNameOccupancy = "OCCUPANCY"

	// HistoricalMetricNameHandleTime is a HistoricalMetricName enum value
	HistoricalMetricNameHandleTime = "HANDLE_TIME"

	// HistoricalMetricNameAfterContactWorkTime is a HistoricalMetricName enum value
	HistoricalMetricNameAfterContactWorkTime = "AFTER_CONTACT_WORK_TIME"

	// HistoricalMetricNameQueuedTime is a HistoricalMetricName enum value
	HistoricalMetricNameQueuedTime = "QUEUED_TIME"

	// HistoricalMetricNameAbandonTime is a HistoricalMetricName enum value
	HistoricalMetricNameAbandonTime = "ABANDON_TIME"

	// HistoricalMetricNameQueueAnswerTime is a HistoricalMetricName enum value
	HistoricalMetricNameQueueAnswerTime = "QUEUE_ANSWER_TIME"

	// HistoricalMetricNameHoldTime is a HistoricalMetricName enum value
	HistoricalMetricNameHoldTime = "HOLD_TIME"

	// HistoricalMetricNameInteractionTime is a HistoricalMetricName enum value
	HistoricalMetricNameInteractionTime = "INTERACTION_TIME"

	// HistoricalMetricNameInteractionAndHoldTime is a HistoricalMetricName enum value
	HistoricalMetricNameInteractionAndHoldTime = "INTERACTION_AND_HOLD_TIME"

	// HistoricalMetricNameServiceLevel is a HistoricalMetricName enum value
	HistoricalMetricNameServiceLevel = "SERVICE_LEVEL"
)

A list of historical metric names.

View Source 
const (
	// PhoneTypeSoftPhone is a PhoneType enum value
	PhoneTypeSoftPhone = "SOFT_PHONE"

	// PhoneTypeDeskPhone is a PhoneType enum value
	PhoneTypeDeskPhone = "DESK_PHONE"
)
View Source 
const (
	// StatisticSum is a Statistic enum value
	StatisticSum = "SUM"

	// StatisticMax is a Statistic enum value
	StatisticMax = "MAX"

	// StatisticAvg is a Statistic enum value
	StatisticAvg = "AVG"
)
View Source 
const (
	// UnitSeconds is a Unit enum value
	UnitSeconds = "SECONDS"

	// UnitCount is a Unit enum value
	UnitCount = "COUNT"

	// UnitPercent is a Unit enum value
	UnitPercent = "PERCENT"
)
View Source 
const (

	// ErrCodeContactNotFoundException for service response error code
	// "ContactNotFoundException".
	//
	// The contact with the specified ID is not active or does not exist.
	ErrCodeContactNotFoundException = "ContactNotFoundException"

	// ErrCodeDestinationNotAllowedException for service response error code
	// "DestinationNotAllowedException".
	//
	// Outbound calls to the destination number are not allowed.
	ErrCodeDestinationNotAllowedException = "DestinationNotAllowedException"

	// ErrCodeDuplicateResourceException for service response error code
	// "DuplicateResourceException".
	//
	// A resource with that name already exists.
	ErrCodeDuplicateResourceException = "DuplicateResourceException"

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// Request processing failed due to an error or failure with the service.
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// One or more of the parameters provided to the operation are not valid.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request is not valid.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The allowed limit for the resource has been reached.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeOutboundContactNotPermittedException for service response error code
	// "OutboundContactNotPermittedException".
	//
	// The contact is not permitted.
	ErrCodeOutboundContactNotPermittedException = "OutboundContactNotPermittedException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The throttling limit has been exceeded.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeUserNotFoundException for service response error code
	// "UserNotFoundException".
	//
	// No user with the specified credentials was found in the Amazon Connect instance.
	ErrCodeUserNotFoundException = "UserNotFoundException"
)
View Source 
const (
	ServiceName = "connect"   // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Connect"   // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source 
const (
	// ChannelVoice is a Channel enum value
	ChannelVoice = "VOICE"
)
View Source 
const (
	// ComparisonLt is a Comparison enum value
	ComparisonLt = "LT"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Connect 

type Connect struct {
	*client.Client
}

Connect provides the API operation methods for making requests to Amazon Connect Service. See this package's package overview docs for details on the service.

Connect methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Connect

New creates a new instance of the Connect client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a Connect client from just a session.
svc := connect.New(mySession)

// Create a Connect client with additional configuration
svc := connect.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Connect) CreateUser 

func (c *Connect) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser API operation for Amazon Connect Service.

Creates a new user account in your Amazon Connect instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation CreateUser for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeLimitExceededException "LimitExceededException" The allowed limit for the resource has been reached.

  • ErrCodeDuplicateResourceException "DuplicateResourceException" A resource with that name already exists.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser

func (*Connect) CreateUserRequest 

func (c *Connect) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUser for more information on using the CreateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateUserRequest method.
req, resp := client.CreateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser

func (*Connect) CreateUserWithContext 

func (c *Connect) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)

CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.

See CreateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) DeleteUser 

func (c *Connect) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for Amazon Connect Service.

Deletes a user account from Amazon Connect.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation DeleteUser for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser

func (*Connect) DeleteUserRequest 

func (c *Connect) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUser for more information on using the DeleteUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteUserRequest method.
req, resp := client.DeleteUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser

func (*Connect) DeleteUserWithContext 

func (c *Connect) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.

See DeleteUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) DescribeUser 

func (c *Connect) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)

DescribeUser API operation for Amazon Connect Service.

Returns a User object that contains information about the user account specified by the UserId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation DescribeUser for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser

func (*Connect) DescribeUserHierarchyGroup 

func (c *Connect) DescribeUserHierarchyGroup(input *DescribeUserHierarchyGroupInput) (*DescribeUserHierarchyGroupOutput, error)

DescribeUserHierarchyGroup API operation for Amazon Connect Service.

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation DescribeUserHierarchyGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup

func (*Connect) DescribeUserHierarchyGroupRequest 

func (c *Connect) DescribeUserHierarchyGroupRequest(input *DescribeUserHierarchyGroupInput) (req *request.Request, output *DescribeUserHierarchyGroupOutput)

DescribeUserHierarchyGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeUserHierarchyGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUserHierarchyGroup for more information on using the DescribeUserHierarchyGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeUserHierarchyGroupRequest method.
req, resp := client.DescribeUserHierarchyGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup

func (*Connect) DescribeUserHierarchyGroupWithContext 

func (c *Connect) DescribeUserHierarchyGroupWithContext(ctx aws.Context, input *DescribeUserHierarchyGroupInput, opts ...request.Option) (*DescribeUserHierarchyGroupOutput, error)

DescribeUserHierarchyGroupWithContext is the same as DescribeUserHierarchyGroup with the addition of the ability to pass a context and additional request options.

See DescribeUserHierarchyGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) DescribeUserHierarchyStructure 

func (c *Connect) DescribeUserHierarchyStructure(input *DescribeUserHierarchyStructureInput) (*DescribeUserHierarchyStructureOutput, error)

DescribeUserHierarchyStructure API operation for Amazon Connect Service.

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation DescribeUserHierarchyStructure for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure

func (*Connect) DescribeUserHierarchyStructureRequest 

func (c *Connect) DescribeUserHierarchyStructureRequest(input *DescribeUserHierarchyStructureInput) (req *request.Request, output *DescribeUserHierarchyStructureOutput)

DescribeUserHierarchyStructureRequest generates a "aws/request.Request" representing the client's request for the DescribeUserHierarchyStructure operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUserHierarchyStructure for more information on using the DescribeUserHierarchyStructure API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeUserHierarchyStructureRequest method.
req, resp := client.DescribeUserHierarchyStructureRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure

func (*Connect) DescribeUserHierarchyStructureWithContext 

func (c *Connect) DescribeUserHierarchyStructureWithContext(ctx aws.Context, input *DescribeUserHierarchyStructureInput, opts ...request.Option) (*DescribeUserHierarchyStructureOutput, error)

DescribeUserHierarchyStructureWithContext is the same as DescribeUserHierarchyStructure with the addition of the ability to pass a context and additional request options.

See DescribeUserHierarchyStructure for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) DescribeUserRequest 

func (c *Connect) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)

DescribeUserRequest generates a "aws/request.Request" representing the client's request for the DescribeUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUser for more information on using the DescribeUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeUserRequest method.
req, resp := client.DescribeUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser

func (*Connect) DescribeUserWithContext 

func (c *Connect) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)

DescribeUserWithContext is the same as DescribeUser with the addition of the ability to pass a context and additional request options.

See DescribeUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) GetContactAttributes 

func (c *Connect) GetContactAttributes(input *GetContactAttributesInput) (*GetContactAttributesOutput, error)

GetContactAttributes API operation for Amazon Connect Service.

Retrieves the contact attributes associated with a contact.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation GetContactAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes

func (*Connect) GetContactAttributesRequest 

func (c *Connect) GetContactAttributesRequest(input *GetContactAttributesInput) (req *request.Request, output *GetContactAttributesOutput)

GetContactAttributesRequest generates a "aws/request.Request" representing the client's request for the GetContactAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetContactAttributes for more information on using the GetContactAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetContactAttributesRequest method.
req, resp := client.GetContactAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes

func (*Connect) GetContactAttributesWithContext 

func (c *Connect) GetContactAttributesWithContext(ctx aws.Context, input *GetContactAttributesInput, opts ...request.Option) (*GetContactAttributesOutput, error)

GetContactAttributesWithContext is the same as GetContactAttributes with the addition of the ability to pass a context and additional request options.

See GetContactAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) GetCurrentMetricData 

func (c *Connect) GetCurrentMetricData(input *GetCurrentMetricDataInput) (*GetCurrentMetricDataOutput, error)

GetCurrentMetricData API operation for Amazon Connect Service.

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation GetCurrentMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData

func (*Connect) GetCurrentMetricDataPages 

func (c *Connect) GetCurrentMetricDataPages(input *GetCurrentMetricDataInput, fn func(*GetCurrentMetricDataOutput, bool) bool) error

GetCurrentMetricDataPages iterates over the pages of a GetCurrentMetricData operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetCurrentMetricData method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetCurrentMetricData operation.
pageNum := 0
err := client.GetCurrentMetricDataPages(params,
    func(page *GetCurrentMetricDataOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Connect) GetCurrentMetricDataPagesWithContext 

func (c *Connect) GetCurrentMetricDataPagesWithContext(ctx aws.Context, input *GetCurrentMetricDataInput, fn func(*GetCurrentMetricDataOutput, bool) bool, opts ...request.Option) error

GetCurrentMetricDataPagesWithContext same as GetCurrentMetricDataPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) GetCurrentMetricDataRequest 

func (c *Connect) GetCurrentMetricDataRequest(input *GetCurrentMetricDataInput) (req *request.Request, output *GetCurrentMetricDataOutput)

GetCurrentMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetCurrentMetricData operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCurrentMetricData for more information on using the GetCurrentMetricData API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetCurrentMetricDataRequest method.
req, resp := client.GetCurrentMetricDataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData

func (*Connect) GetCurrentMetricDataWithContext 

func (c *Connect) GetCurrentMetricDataWithContext(ctx aws.Context, input *GetCurrentMetricDataInput, opts ...request.Option) (*GetCurrentMetricDataOutput, error)

GetCurrentMetricDataWithContext is the same as GetCurrentMetricData with the addition of the ability to pass a context and additional request options.

See GetCurrentMetricData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) GetFederationToken 

func (c *Connect) GetFederationToken(input *GetFederationTokenInput) (*GetFederationTokenOutput, error)

GetFederationToken API operation for Amazon Connect Service.

Retrieves a token for federation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation GetFederationToken for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeUserNotFoundException "UserNotFoundException" No user with the specified credentials was found in the Amazon Connect instance.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

  • ErrCodeDuplicateResourceException "DuplicateResourceException" A resource with that name already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken

func (*Connect) GetFederationTokenRequest 

func (c *Connect) GetFederationTokenRequest(input *GetFederationTokenInput) (req *request.Request, output *GetFederationTokenOutput)

GetFederationTokenRequest generates a "aws/request.Request" representing the client's request for the GetFederationToken operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFederationToken for more information on using the GetFederationToken API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetFederationTokenRequest method.
req, resp := client.GetFederationTokenRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken

func (*Connect) GetFederationTokenWithContext 

func (c *Connect) GetFederationTokenWithContext(ctx aws.Context, input *GetFederationTokenInput, opts ...request.Option) (*GetFederationTokenOutput, error)

GetFederationTokenWithContext is the same as GetFederationToken with the addition of the ability to pass a context and additional request options.

See GetFederationToken for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) GetMetricData 

func (c *Connect) GetMetricData(input *GetMetricDataInput) (*GetMetricDataOutput, error)

GetMetricData API operation for Amazon Connect Service.

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetMetricData action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation GetMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData

func (*Connect) GetMetricDataPages 

func (c *Connect) GetMetricDataPages(input *GetMetricDataInput, fn func(*GetMetricDataOutput, bool) bool) error

GetMetricDataPages iterates over the pages of a GetMetricData operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetMetricData method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetMetricData operation.
pageNum := 0
err := client.GetMetricDataPages(params,
    func(page *GetMetricDataOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Connect) GetMetricDataPagesWithContext 

func (c *Connect) GetMetricDataPagesWithContext(ctx aws.Context, input *GetMetricDataInput, fn func(*GetMetricDataOutput, bool) bool, opts ...request.Option) error

GetMetricDataPagesWithContext same as GetMetricDataPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) GetMetricDataRequest 

func (c *Connect) GetMetricDataRequest(input *GetMetricDataInput) (req *request.Request, output *GetMetricDataOutput)

GetMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetMetricData operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMetricData for more information on using the GetMetricData API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetMetricDataRequest method.
req, resp := client.GetMetricDataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData

func (*Connect) GetMetricDataWithContext 

func (c *Connect) GetMetricDataWithContext(ctx aws.Context, input *GetMetricDataInput, opts ...request.Option) (*GetMetricDataOutput, error)

GetMetricDataWithContext is the same as GetMetricData with the addition of the ability to pass a context and additional request options.

See GetMetricData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) ListRoutingProfiles 

func (c *Connect) ListRoutingProfiles(input *ListRoutingProfilesInput) (*ListRoutingProfilesOutput, error)

ListRoutingProfiles API operation for Amazon Connect Service.

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation ListRoutingProfiles for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles

func (*Connect) ListRoutingProfilesRequest 

func (c *Connect) ListRoutingProfilesRequest(input *ListRoutingProfilesInput) (req *request.Request, output *ListRoutingProfilesOutput)

ListRoutingProfilesRequest generates a "aws/request.Request" representing the client's request for the ListRoutingProfiles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRoutingProfiles for more information on using the ListRoutingProfiles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListRoutingProfilesRequest method.
req, resp := client.ListRoutingProfilesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles

func (*Connect) ListRoutingProfilesWithContext 

func (c *Connect) ListRoutingProfilesWithContext(ctx aws.Context, input *ListRoutingProfilesInput, opts ...request.Option) (*ListRoutingProfilesOutput, error)

ListRoutingProfilesWithContext is the same as ListRoutingProfiles with the addition of the ability to pass a context and additional request options.

See ListRoutingProfiles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) ListSecurityProfiles 

func (c *Connect) ListSecurityProfiles(input *ListSecurityProfilesInput) (*ListSecurityProfilesOutput, error)

ListSecurityProfiles API operation for Amazon Connect Service.

Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation ListSecurityProfiles for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles

func (*Connect) ListSecurityProfilesRequest 

func (c *Connect) ListSecurityProfilesRequest(input *ListSecurityProfilesInput) (req *request.Request, output *ListSecurityProfilesOutput)

ListSecurityProfilesRequest generates a "aws/request.Request" representing the client's request for the ListSecurityProfiles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSecurityProfiles for more information on using the ListSecurityProfiles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListSecurityProfilesRequest method.
req, resp := client.ListSecurityProfilesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles

func (*Connect) ListSecurityProfilesWithContext 

func (c *Connect) ListSecurityProfilesWithContext(ctx aws.Context, input *ListSecurityProfilesInput, opts ...request.Option) (*ListSecurityProfilesOutput, error)

ListSecurityProfilesWithContext is the same as ListSecurityProfiles with the addition of the ability to pass a context and additional request options.

See ListSecurityProfiles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) ListUserHierarchyGroups 

func (c *Connect) ListUserHierarchyGroups(input *ListUserHierarchyGroupsInput) (*ListUserHierarchyGroupsOutput, error)

ListUserHierarchyGroups API operation for Amazon Connect Service.

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation ListUserHierarchyGroups for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups

func (*Connect) ListUserHierarchyGroupsRequest 

func (c *Connect) ListUserHierarchyGroupsRequest(input *ListUserHierarchyGroupsInput) (req *request.Request, output *ListUserHierarchyGroupsOutput)

ListUserHierarchyGroupsRequest generates a "aws/request.Request" representing the client's request for the ListUserHierarchyGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListUserHierarchyGroups for more information on using the ListUserHierarchyGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListUserHierarchyGroupsRequest method.
req, resp := client.ListUserHierarchyGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups

func (*Connect) ListUserHierarchyGroupsWithContext 

func (c *Connect) ListUserHierarchyGroupsWithContext(ctx aws.Context, input *ListUserHierarchyGroupsInput, opts ...request.Option) (*ListUserHierarchyGroupsOutput, error)

ListUserHierarchyGroupsWithContext is the same as ListUserHierarchyGroups with the addition of the ability to pass a context and additional request options.

See ListUserHierarchyGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) ListUsers 

func (c *Connect) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)

ListUsers API operation for Amazon Connect Service.

Returns a UserSummaryList, which is an array of UserSummary objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation ListUsers for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers

func (*Connect) ListUsersRequest 

func (c *Connect) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)

ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListUsers for more information on using the ListUsers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListUsersRequest method.
req, resp := client.ListUsersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers

func (*Connect) ListUsersWithContext 

func (c *Connect) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)

ListUsersWithContext is the same as ListUsers with the addition of the ability to pass a context and additional request options.

See ListUsers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) StartOutboundVoiceContact 

func (c *Connect) StartOutboundVoiceContact(input *StartOutboundVoiceContactInput) (*StartOutboundVoiceContactOutput, error)

StartOutboundVoiceContact API operation for Amazon Connect Service.

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation StartOutboundVoiceContact for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

  • ErrCodeLimitExceededException "LimitExceededException" The allowed limit for the resource has been reached.

  • ErrCodeDestinationNotAllowedException "DestinationNotAllowedException" Outbound calls to the destination number are not allowed.

  • ErrCodeOutboundContactNotPermittedException "OutboundContactNotPermittedException" The contact is not permitted.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact

func (*Connect) StartOutboundVoiceContactRequest 

func (c *Connect) StartOutboundVoiceContactRequest(input *StartOutboundVoiceContactInput) (req *request.Request, output *StartOutboundVoiceContactOutput)

StartOutboundVoiceContactRequest generates a "aws/request.Request" representing the client's request for the StartOutboundVoiceContact operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartOutboundVoiceContact for more information on using the StartOutboundVoiceContact API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartOutboundVoiceContactRequest method.
req, resp := client.StartOutboundVoiceContactRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact

func (*Connect) StartOutboundVoiceContactWithContext 

func (c *Connect) StartOutboundVoiceContactWithContext(ctx aws.Context, input *StartOutboundVoiceContactInput, opts ...request.Option) (*StartOutboundVoiceContactOutput, error)

StartOutboundVoiceContactWithContext is the same as StartOutboundVoiceContact with the addition of the ability to pass a context and additional request options.

See StartOutboundVoiceContact for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) StopContact 

func (c *Connect) StopContact(input *StopContactInput) (*StopContactOutput, error)

StopContact API operation for Amazon Connect Service.

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permission to the connect:StopContact action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation StopContact for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeContactNotFoundException "ContactNotFoundException" The contact with the specified ID is not active or does not exist.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact

func (*Connect) StopContactRequest 

func (c *Connect) StopContactRequest(input *StopContactInput) (req *request.Request, output *StopContactOutput)

StopContactRequest generates a "aws/request.Request" representing the client's request for the StopContact operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopContact for more information on using the StopContact API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopContactRequest method.
req, resp := client.StopContactRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact

func (*Connect) StopContactWithContext 

func (c *Connect) StopContactWithContext(ctx aws.Context, input *StopContactInput, opts ...request.Option) (*StopContactOutput, error)

StopContactWithContext is the same as StopContact with the addition of the ability to pass a context and additional request options.

See StopContact for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) UpdateContactAttributes 

func (c *Connect) UpdateContactAttributes(input *UpdateContactAttributesInput) (*UpdateContactAttributesOutput, error)

UpdateContactAttributes API operation for Amazon Connect Service.

The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the UpdateContactAttributes operation to 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 identifying abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Important:

You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation UpdateContactAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactAttributes

func (*Connect) UpdateContactAttributesRequest 

func (c *Connect) UpdateContactAttributesRequest(input *UpdateContactAttributesInput) (req *request.Request, output *UpdateContactAttributesOutput)

UpdateContactAttributesRequest generates a "aws/request.Request" representing the client's request for the UpdateContactAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateContactAttributes for more information on using the UpdateContactAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateContactAttributesRequest method.
req, resp := client.UpdateContactAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactAttributes

func (*Connect) UpdateContactAttributesWithContext 

func (c *Connect) UpdateContactAttributesWithContext(ctx aws.Context, input *UpdateContactAttributesInput, opts ...request.Option) (*UpdateContactAttributesOutput, error)

UpdateContactAttributesWithContext is the same as UpdateContactAttributes with the addition of the ability to pass a context and additional request options.

See UpdateContactAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) UpdateUserHierarchy 

func (c *Connect) UpdateUserHierarchy(input *UpdateUserHierarchyInput) (*UpdateUserHierarchyOutput, error)

UpdateUserHierarchy API operation for Amazon Connect Service.

Assigns the specified hierarchy group to the user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserHierarchy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy

func (*Connect) UpdateUserHierarchyRequest 

func (c *Connect) UpdateUserHierarchyRequest(input *UpdateUserHierarchyInput) (req *request.Request, output *UpdateUserHierarchyOutput)

UpdateUserHierarchyRequest generates a "aws/request.Request" representing the client's request for the UpdateUserHierarchy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateUserHierarchy for more information on using the UpdateUserHierarchy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateUserHierarchyRequest method.
req, resp := client.UpdateUserHierarchyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy

func (*Connect) UpdateUserHierarchyWithContext 

func (c *Connect) UpdateUserHierarchyWithContext(ctx aws.Context, input *UpdateUserHierarchyInput, opts ...request.Option) (*UpdateUserHierarchyOutput, error)

UpdateUserHierarchyWithContext is the same as UpdateUserHierarchy with the addition of the ability to pass a context and additional request options.

See UpdateUserHierarchy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) UpdateUserIdentityInfo 

func (c *Connect) UpdateUserIdentityInfo(input *UpdateUserIdentityInfoInput) (*UpdateUserIdentityInfoOutput, error)

UpdateUserIdentityInfo API operation for Amazon Connect Service.

Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserIdentityInfo for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo

func (*Connect) UpdateUserIdentityInfoRequest 

func (c *Connect) UpdateUserIdentityInfoRequest(input *UpdateUserIdentityInfoInput) (req *request.Request, output *UpdateUserIdentityInfoOutput)

UpdateUserIdentityInfoRequest generates a "aws/request.Request" representing the client's request for the UpdateUserIdentityInfo operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateUserIdentityInfo for more information on using the UpdateUserIdentityInfo API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateUserIdentityInfoRequest method.
req, resp := client.UpdateUserIdentityInfoRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo

func (*Connect) UpdateUserIdentityInfoWithContext 

func (c *Connect) UpdateUserIdentityInfoWithContext(ctx aws.Context, input *UpdateUserIdentityInfoInput, opts ...request.Option) (*UpdateUserIdentityInfoOutput, error)

UpdateUserIdentityInfoWithContext is the same as UpdateUserIdentityInfo with the addition of the ability to pass a context and additional request options.

See UpdateUserIdentityInfo for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) UpdateUserPhoneConfig 

func (c *Connect) UpdateUserPhoneConfig(input *UpdateUserPhoneConfigInput) (*UpdateUserPhoneConfigOutput, error)

UpdateUserPhoneConfig API operation for Amazon Connect Service.

Updates the phone configuration settings in the UserPhoneConfig object for the specified user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserPhoneConfig for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig

func (*Connect) UpdateUserPhoneConfigRequest 

func (c *Connect) UpdateUserPhoneConfigRequest(input *UpdateUserPhoneConfigInput) (req *request.Request, output *UpdateUserPhoneConfigOutput)

UpdateUserPhoneConfigRequest generates a "aws/request.Request" representing the client's request for the UpdateUserPhoneConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateUserPhoneConfig for more information on using the UpdateUserPhoneConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateUserPhoneConfigRequest method.
req, resp := client.UpdateUserPhoneConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig

func (*Connect) UpdateUserPhoneConfigWithContext 

func (c *Connect) UpdateUserPhoneConfigWithContext(ctx aws.Context, input *UpdateUserPhoneConfigInput, opts ...request.Option) (*UpdateUserPhoneConfigOutput, error)

UpdateUserPhoneConfigWithContext is the same as UpdateUserPhoneConfig with the addition of the ability to pass a context and additional request options.

See UpdateUserPhoneConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) UpdateUserRoutingProfile 

func (c *Connect) UpdateUserRoutingProfile(input *UpdateUserRoutingProfileInput) (*UpdateUserRoutingProfileOutput, error)

UpdateUserRoutingProfile API operation for Amazon Connect Service.

Assigns the specified routing profile to a user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserRoutingProfile for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile

func (*Connect) UpdateUserRoutingProfileRequest 

func (c *Connect) UpdateUserRoutingProfileRequest(input *UpdateUserRoutingProfileInput) (req *request.Request, output *UpdateUserRoutingProfileOutput)

UpdateUserRoutingProfileRequest generates a "aws/request.Request" representing the client's request for the UpdateUserRoutingProfile operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateUserRoutingProfile for more information on using the UpdateUserRoutingProfile API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateUserRoutingProfileRequest method.
req, resp := client.UpdateUserRoutingProfileRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile

func (*Connect) UpdateUserRoutingProfileWithContext 

func (c *Connect) UpdateUserRoutingProfileWithContext(ctx aws.Context, input *UpdateUserRoutingProfileInput, opts ...request.Option) (*UpdateUserRoutingProfileOutput, error)

UpdateUserRoutingProfileWithContext is the same as UpdateUserRoutingProfile with the addition of the ability to pass a context and additional request options.

See UpdateUserRoutingProfile for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Connect) UpdateUserSecurityProfiles 

func (c *Connect) UpdateUserSecurityProfiles(input *UpdateUserSecurityProfilesInput) (*UpdateUserSecurityProfilesOutput, error)

UpdateUserSecurityProfiles API operation for Amazon Connect Service.

Updates the security profiles assigned to the user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserSecurityProfiles for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles

func (*Connect) UpdateUserSecurityProfilesRequest 

func (c *Connect) UpdateUserSecurityProfilesRequest(input *UpdateUserSecurityProfilesInput) (req *request.Request, output *UpdateUserSecurityProfilesOutput)

UpdateUserSecurityProfilesRequest generates a "aws/request.Request" representing the client's request for the UpdateUserSecurityProfiles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateUserSecurityProfiles for more information on using the UpdateUserSecurityProfiles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateUserSecurityProfilesRequest method.
req, resp := client.UpdateUserSecurityProfilesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles

func (*Connect) UpdateUserSecurityProfilesWithContext 

func (c *Connect) UpdateUserSecurityProfilesWithContext(ctx aws.Context, input *UpdateUserSecurityProfilesInput, opts ...request.Option) (*UpdateUserSecurityProfilesOutput, error)

UpdateUserSecurityProfilesWithContext is the same as UpdateUserSecurityProfiles with the addition of the ability to pass a context and additional request options.

See UpdateUserSecurityProfiles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CreateUserInput 

type CreateUserInput struct {

	// The unique identifier for the user account in the directory service directory
	// used for identity management. If Amazon Connect is unable to access the existing
	// directory, you can use the DirectoryUserId to authenticate users. If you
	// include the parameter, it is assumed that Amazon Connect cannot access the
	// directory. If the parameter is not included, the UserIdentityInfo is used
	// to authenticate users from your existing 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 InvalidRequestException is returned.
	DirectoryUserId *string `type:"string"`

	// The unique identifier for the hierarchy group to assign to the user created.
	HierarchyGroupId *string `type:"string"`

	// Information about the user, including email address, first name, and last
	// name.
	IdentityInfo *UserIdentityInfo `type:"structure"`

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The password for the user account to create. This is required if you are
	// using Amazon Connect for identity management. If you are using SAML for identity
	// management and include this parameter, an InvalidRequestException is returned.
	Password *string `type:"string"`

	// Specifies the phone settings for the user, including AfterContactWorkTimeLimit,
	// AutoAccept, DeskPhoneNumber, and PhoneType.
	//
	// PhoneConfig is a required field
	PhoneConfig *UserPhoneConfig `type:"structure" required:"true"`

	// The unique identifier for the routing profile to assign to the user created.
	//
	// RoutingProfileId is a required field
	RoutingProfileId *string `type:"string" required:"true"`

	// The unique identifier of the security profile to assign to the user created.
	//
	// SecurityProfileIds is a required field
	SecurityProfileIds []*string `min:"1" type:"list" required:"true"`

	// The user name in Amazon Connect for the account to create. If you are using
	// SAML for identity management in your Amazon Connect, the value for Username
	// can include up to 64 characters from [a-zA-Z0-9_-.\@]+.
	//
	// Username is a required field
	Username *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateUserInput) GoString 

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (*CreateUserInput) SetDirectoryUserId 

func (s *CreateUserInput) SetDirectoryUserId(v string) *CreateUserInput

SetDirectoryUserId sets the DirectoryUserId field's value.

func (*CreateUserInput) SetHierarchyGroupId 

func (s *CreateUserInput) SetHierarchyGroupId(v string) *CreateUserInput

SetHierarchyGroupId sets the HierarchyGroupId field's value.

func (*CreateUserInput) SetIdentityInfo 

func (s *CreateUserInput) SetIdentityInfo(v *UserIdentityInfo) *CreateUserInput

SetIdentityInfo sets the IdentityInfo field's value.

func (*CreateUserInput) SetInstanceId 

func (s *CreateUserInput) SetInstanceId(v string) *CreateUserInput

SetInstanceId sets the InstanceId field's value.

func (*CreateUserInput) SetPassword 

func (s *CreateUserInput) SetPassword(v string) *CreateUserInput

SetPassword sets the Password field's value.

func (*CreateUserInput) SetPhoneConfig 

func (s *CreateUserInput) SetPhoneConfig(v *UserPhoneConfig) *CreateUserInput

SetPhoneConfig sets the PhoneConfig field's value.

func (*CreateUserInput) SetRoutingProfileId 

func (s *CreateUserInput) SetRoutingProfileId(v string) *CreateUserInput

SetRoutingProfileId sets the RoutingProfileId field's value.

func (*CreateUserInput) SetSecurityProfileIds 

func (s *CreateUserInput) SetSecurityProfileIds(v []*string) *CreateUserInput

SetSecurityProfileIds sets the SecurityProfileIds field's value.

func (*CreateUserInput) SetUsername 

func (s *CreateUserInput) SetUsername(v string) *CreateUserInput

SetUsername sets the Username field's value.

func (CreateUserInput) String 

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate 

func (s *CreateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateUserOutput 

type CreateUserOutput struct {

	// The Amazon Resource Name (ARN) of the user account created.
	UserArn *string `type:"string"`

	// The unique identifier for the user account in Amazon Connect
	UserId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateUserOutput) GoString 

func (s CreateUserOutput) GoString() string

GoString returns the string representation

func (*CreateUserOutput) SetUserArn 

func (s *CreateUserOutput) SetUserArn(v string) *CreateUserOutput

SetUserArn sets the UserArn field's value.

func (*CreateUserOutput) SetUserId 

func (s *CreateUserOutput) SetUserId(v string) *CreateUserOutput

SetUserId sets the UserId field's value.

func (CreateUserOutput) String 

func (s CreateUserOutput) String() string

String returns the string representation

type Credentials 

type Credentials struct {

	// An access token generated for a federated user to access Amazon Connect
	AccessToken *string `type:"string" sensitive:"true"`

	// A token generated with an expiration time for the session a user is logged
	// in to Amazon Connect
	AccessTokenExpiration *time.Time `type:"timestamp"`

	// Renews a token generated for a user to access the Amazon Connect instance.
	RefreshToken *string `type:"string" sensitive:"true"`

	// Renews the expiration timer for a generated token.
	RefreshTokenExpiration *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The credentials to use for federation.

func (Credentials) GoString 

func (s Credentials) GoString() string

GoString returns the string representation

func (*Credentials) SetAccessToken 

func (s *Credentials) SetAccessToken(v string) *Credentials

SetAccessToken sets the AccessToken field's value.

func (*Credentials) SetAccessTokenExpiration 

func (s *Credentials) SetAccessTokenExpiration(v time.Time) *Credentials

SetAccessTokenExpiration sets the AccessTokenExpiration field's value.

func (*Credentials) SetRefreshToken 

func (s *Credentials) SetRefreshToken(v string) *Credentials

SetRefreshToken sets the RefreshToken field's value.

func (*Credentials) SetRefreshTokenExpiration 

func (s *Credentials) SetRefreshTokenExpiration(v time.Time) *Credentials

SetRefreshTokenExpiration sets the RefreshTokenExpiration field's value.

func (Credentials) String 

func (s Credentials) String() string

String returns the string representation

type CurrentMetric 

type CurrentMetric struct {

	// The name of the metric.
	Name *string `type:"string" enum:"CurrentMetricName"`

	// The unit for the metric.
	Unit *string `type:"string" enum:"Unit"`
	// contains filtered or unexported fields
}

A CurrentMetric object that contains the Name and Unit for the metric.

func (CurrentMetric) GoString 

func (s CurrentMetric) GoString() string

GoString returns the string representation

func (*CurrentMetric) SetName 

func (s *CurrentMetric) SetName(v string) *CurrentMetric

SetName sets the Name field's value.

func (*CurrentMetric) SetUnit 

func (s *CurrentMetric) SetUnit(v string) *CurrentMetric

SetUnit sets the Unit field's value.

func (CurrentMetric) String 

func (s CurrentMetric) String() string

String returns the string representation

type CurrentMetricData 

type CurrentMetricData struct {

	// The metric in a CurrentMetricData object.
	Metric *CurrentMetric `type:"structure"`

	// The value of the metric in the CurrentMetricData object.
	Value *float64 `type:"double"`
	// contains filtered or unexported fields
}

A CurrentMetricData object.

func (CurrentMetricData) GoString 

func (s CurrentMetricData) GoString() string

GoString returns the string representation

func (*CurrentMetricData) SetMetric 

func (s *CurrentMetricData) SetMetric(v *CurrentMetric) *CurrentMetricData

SetMetric sets the Metric field's value.

func (*CurrentMetricData) SetValue 

func (s *CurrentMetricData) SetValue(v float64) *CurrentMetricData

SetValue sets the Value field's value.

func (CurrentMetricData) String 

func (s CurrentMetricData) String() string

String returns the string representation

type CurrentMetricResult 

type CurrentMetricResult struct {

	// The Collections for the CurrentMetricResult object.
	Collections []*CurrentMetricData `type:"list"`

	// The Dimensions for the CurrentMetricResult object.
	Dimensions *Dimensions `type:"structure"`
	// contains filtered or unexported fields
}

A CurrentMetricResult object.

func (CurrentMetricResult) GoString 

func (s CurrentMetricResult) GoString() string

GoString returns the string representation

func (*CurrentMetricResult) SetCollections 

func (s *CurrentMetricResult) SetCollections(v []*CurrentMetricData) *CurrentMetricResult

SetCollections sets the Collections field's value.

func (*CurrentMetricResult) SetDimensions 

func (s *CurrentMetricResult) SetDimensions(v *Dimensions) *CurrentMetricResult

SetDimensions sets the Dimensions field's value.

func (CurrentMetricResult) String 

func (s CurrentMetricResult) String() string

String returns the string representation

type DeleteUserInput 

type DeleteUserInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The unique identifier of the user to delete.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserInput) GoString 

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (*DeleteUserInput) SetInstanceId 

func (s *DeleteUserInput) SetInstanceId(v string) *DeleteUserInput

SetInstanceId sets the InstanceId field's value.

func (*DeleteUserInput) SetUserId 

func (s *DeleteUserInput) SetUserId(v string) *DeleteUserInput

SetUserId sets the UserId field's value.

func (DeleteUserInput) String 

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate 

func (s *DeleteUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteUserOutput 

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

func (DeleteUserOutput) GoString 

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) String 

func (s DeleteUserOutput) String() string

String returns the string representation

type DescribeUserHierarchyGroupInput 

type DescribeUserHierarchyGroupInput struct {

	// The identifier for the hierarchy group to return.
	//
	// HierarchyGroupId is a required field
	HierarchyGroupId *string `location:"uri" locationName:"HierarchyGroupId" type:"string" required:"true"`

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeUserHierarchyGroupInput) GoString 

func (s DescribeUserHierarchyGroupInput) GoString() string

GoString returns the string representation

func (*DescribeUserHierarchyGroupInput) SetHierarchyGroupId 

func (s *DescribeUserHierarchyGroupInput) SetHierarchyGroupId(v string) *DescribeUserHierarchyGroupInput

SetHierarchyGroupId sets the HierarchyGroupId field's value.

func (*DescribeUserHierarchyGroupInput) SetInstanceId 

func (s *DescribeUserHierarchyGroupInput) SetInstanceId(v string) *DescribeUserHierarchyGroupInput

SetInstanceId sets the InstanceId field's value.

func (DescribeUserHierarchyGroupInput) String 

func (s DescribeUserHierarchyGroupInput) String() string

String returns the string representation

func (*DescribeUserHierarchyGroupInput) Validate 

func (s *DescribeUserHierarchyGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUserHierarchyGroupOutput 

type DescribeUserHierarchyGroupOutput struct {

	// Returns a HierarchyGroup object.
	HierarchyGroup *HierarchyGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeUserHierarchyGroupOutput) GoString 

func (s DescribeUserHierarchyGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeUserHierarchyGroupOutput) SetHierarchyGroup 

func (s *DescribeUserHierarchyGroupOutput) SetHierarchyGroup(v *HierarchyGroup) *DescribeUserHierarchyGroupOutput

SetHierarchyGroup sets the HierarchyGroup field's value.

func (DescribeUserHierarchyGroupOutput) String 

func (s DescribeUserHierarchyGroupOutput) String() string

String returns the string representation

type DescribeUserHierarchyStructureInput 

type DescribeUserHierarchyStructureInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeUserHierarchyStructureInput) GoString 

func (s DescribeUserHierarchyStructureInput) GoString() string

GoString returns the string representation

func (*DescribeUserHierarchyStructureInput) SetInstanceId 

func (s *DescribeUserHierarchyStructureInput) SetInstanceId(v string) *DescribeUserHierarchyStructureInput

SetInstanceId sets the InstanceId field's value.

func (DescribeUserHierarchyStructureInput) String 

func (s DescribeUserHierarchyStructureInput) String() string

String returns the string representation

func (*DescribeUserHierarchyStructureInput) Validate 

func (s *DescribeUserHierarchyStructureInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUserHierarchyStructureOutput 

type DescribeUserHierarchyStructureOutput struct {

	// A HierarchyStructure object.
	HierarchyStructure *HierarchyStructure `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeUserHierarchyStructureOutput) GoString 

func (s DescribeUserHierarchyStructureOutput) GoString() string

GoString returns the string representation

func (*DescribeUserHierarchyStructureOutput) SetHierarchyStructure 

func (s *DescribeUserHierarchyStructureOutput) SetHierarchyStructure(v *HierarchyStructure) *DescribeUserHierarchyStructureOutput

SetHierarchyStructure sets the HierarchyStructure field's value.

func (DescribeUserHierarchyStructureOutput) String 

func (s DescribeUserHierarchyStructureOutput) String() string

String returns the string representation

type DescribeUserInput 

type DescribeUserInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// Unique identifier for the user account to return.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeUserInput) GoString 

func (s DescribeUserInput) GoString() string

GoString returns the string representation

func (*DescribeUserInput) SetInstanceId 

func (s *DescribeUserInput) SetInstanceId(v string) *DescribeUserInput

SetInstanceId sets the InstanceId field's value.

func (*DescribeUserInput) SetUserId 

func (s *DescribeUserInput) SetUserId(v string) *DescribeUserInput

SetUserId sets the UserId field's value.

func (DescribeUserInput) String 

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate 

func (s *DescribeUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUserOutput 

type DescribeUserOutput struct {

	// A User object that contains information about the user account and configuration
	// settings.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeUserOutput) GoString 

func (s DescribeUserOutput) GoString() string

GoString returns the string representation

func (*DescribeUserOutput) SetUser 

func (s *DescribeUserOutput) SetUser(v *User) *DescribeUserOutput

SetUser sets the User field's value.

func (DescribeUserOutput) String 

func (s DescribeUserOutput) String() string

String returns the string representation

type Dimensions 

type Dimensions struct {

	// The channel used for grouping and filters. Only VOICE is supported.
	Channel *string `type:"string" enum:"Channel"`

	// A QueueReference object used as one part of dimension for the metrics results.
	Queue *QueueReference `type:"structure"`
	// contains filtered or unexported fields
}

A Dimensions object that includes the Channel and Queue for the metric.

func (Dimensions) GoString 

func (s Dimensions) GoString() string

GoString returns the string representation

func (*Dimensions) SetChannel 

func (s *Dimensions) SetChannel(v string) *Dimensions

SetChannel sets the Channel field's value.

func (*Dimensions) SetQueue 

func (s *Dimensions) SetQueue(v *QueueReference) *Dimensions

SetQueue sets the Queue field's value.

func (Dimensions) String 

func (s Dimensions) String() string

String returns the string representation

type Filters 

type Filters struct {

	// The Channel to use as a filter for the metrics returned. Only VOICE is supported.
	Channels []*string `type:"list"`

	// A list of up to 100 queue IDs or queue ARNs to use to filter the metrics
	// retrieved. You can include both IDs and ARNs in a request.
	Queues []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The filter, either channel or queues, to apply to the metric results retrieved.

func (Filters) GoString 

func (s Filters) GoString() string

GoString returns the string representation

func (*Filters) SetChannels 

func (s *Filters) SetChannels(v []*string) *Filters

SetChannels sets the Channels field's value.

func (*Filters) SetQueues 

func (s *Filters) SetQueues(v []*string) *Filters

SetQueues sets the Queues field's value.

func (Filters) String 

func (s Filters) String() string

String returns the string representation

func (*Filters) Validate 

func (s *Filters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetContactAttributesInput 

type GetContactAttributesInput struct {

	// The ID for the initial contact in Amazon Connect associated with the attributes
	// to update.
	//
	// InitialContactId is a required field
	InitialContactId *string `location:"uri" locationName:"InitialContactId" min:"1" type:"string" required:"true"`

	// The instance ID for the instance from which to retrieve contact attributes.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetContactAttributesInput) GoString 

func (s GetContactAttributesInput) GoString() string

GoString returns the string representation

func (*GetContactAttributesInput) SetInitialContactId 

func (s *GetContactAttributesInput) SetInitialContactId(v string) *GetContactAttributesInput

SetInitialContactId sets the InitialContactId field's value.

func (*GetContactAttributesInput) SetInstanceId 

func (s *GetContactAttributesInput) SetInstanceId(v string) *GetContactAttributesInput

SetInstanceId sets the InstanceId field's value.

func (GetContactAttributesInput) String 

func (s GetContactAttributesInput) String() string

String returns the string representation

func (*GetContactAttributesInput) Validate 

func (s *GetContactAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetContactAttributesOutput 

type GetContactAttributesOutput struct {

	// The attributes to update.
	Attributes map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (GetContactAttributesOutput) GoString 

func (s GetContactAttributesOutput) GoString() string

GoString returns the string representation

func (*GetContactAttributesOutput) SetAttributes 

func (s *GetContactAttributesOutput) SetAttributes(v map[string]*string) *GetContactAttributesOutput

SetAttributes sets the Attributes field's value.

func (GetContactAttributesOutput) String 

func (s GetContactAttributesOutput) String() string

String returns the string representation

type GetCurrentMetricDataInput 

type GetCurrentMetricDataInput struct {

	// A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric
	// includes a name of a metric to retrieve and the unit to use for it. You must
	// list each metric to retrieve data for in the request.
	//
	// The following metrics are available:
	//
	// AGENTS_AVAILABLEUnit: COUNT
	//
	// AGENTS_ONLINEUnit: COUNT
	//
	// AGENTS_ON_CALLUnit: COUNT
	//
	// AGENTS_STAFFEDUnit: COUNT
	//
	// AGENTS_AFTER_CONTACT_WORKUnit: COUNT
	//
	// AGENTS_NON_PRODUCTIVEUnit: COUNT
	//
	// AGENTS_ERRORUnit: COUNT
	//
	// CONTACTS_IN_QUEUEUnit: COUNT
	//
	// OLDEST_CONTACT_AGEUnit: SECONDS
	//
	// CONTACTS_SCHEDULEDUnit: COUNT
	//
	// CurrentMetrics is a required field
	CurrentMetrics []*CurrentMetric `type:"list" required:"true"`

	// A Filters object that contains a list of queue IDs or queue ARNs, up to 100,
	// or list of Channels to use to filter the metrics returned in the response.
	// Metric data is retrieved only for the resources associated with the queue
	// IDs, ARNs, or Channels included in the filter. You can include both IDs and
	// ARNs in the same request. To retrieve metrics for all queues, add the queue
	// ID or ARN for each queue in your instance. Only VOICE is supported for Channels.
	//
	// To find the ARN for a queue, open the queue you want to use in the Amazon
	// Connect Queue editor. The ARN for the queue is displayed in the address bar
	// as part of the URL. For example, the queue ARN is the set of characters at
	// the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61.
	// The queue ID is also included in the URL, and is the string after 'queue/'.
	//
	// Filters is a required field
	Filters *Filters `type:"structure" required:"true"`

	// 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.
	// The only supported channel is VOICE.
	//
	// If no Grouping is included in the request, a summary of CurrentMetrics is
	// returned.
	Groupings []*string `type:"list"`

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// MaxResults indicates the maximum number of results to return per page in
	// the response, between 1 and 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 NextToken must use the same request parameters as the
	// request that generated the token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCurrentMetricDataInput) GoString 

func (s GetCurrentMetricDataInput) GoString() string

GoString returns the string representation

func (*GetCurrentMetricDataInput) SetCurrentMetrics 

func (s *GetCurrentMetricDataInput) SetCurrentMetrics(v []*CurrentMetric) *GetCurrentMetricDataInput

SetCurrentMetrics sets the CurrentMetrics field's value.

func (*GetCurrentMetricDataInput) SetFilters 

func (s *GetCurrentMetricDataInput) SetFilters(v *Filters) *GetCurrentMetricDataInput

SetFilters sets the Filters field's value.

func (*GetCurrentMetricDataInput) SetGroupings 

func (s *GetCurrentMetricDataInput) SetGroupings(v []*string) *GetCurrentMetricDataInput

SetGroupings sets the Groupings field's value.

func (*GetCurrentMetricDataInput) SetInstanceId 

func (s *GetCurrentMetricDataInput) SetInstanceId(v string) *GetCurrentMetricDataInput

SetInstanceId sets the InstanceId field's value.

func (*GetCurrentMetricDataInput) SetMaxResults 

func (s *GetCurrentMetricDataInput) SetMaxResults(v int64) *GetCurrentMetricDataInput

SetMaxResults sets the MaxResults field's value.

func (*GetCurrentMetricDataInput) SetNextToken 

func (s *GetCurrentMetricDataInput) SetNextToken(v string) *GetCurrentMetricDataInput

SetNextToken sets the NextToken field's value.

func (GetCurrentMetricDataInput) String 

func (s GetCurrentMetricDataInput) String() string

String returns the string representation

func (*GetCurrentMetricDataInput) Validate 

func (s *GetCurrentMetricDataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCurrentMetricDataOutput 

type GetCurrentMetricDataOutput struct {

	// The time at which CurrentMetricData was retrieved and cached for pagination.
	DataSnapshotTime *time.Time `type:"timestamp"`

	// A list of CurrentMetricResult objects organized by Dimensions combining with
	// CurrentMetricDataCollections.
	//
	// Dimensions is the resourceId specified in the Filters of the request.
	//
	// Collections is a list of CurrentMetricData objects with corresponding values
	// to the CurrentMetrics specified in the request.
	//
	// If no Grouping is specified in the request, Collections is a summary for
	// the CurrentMetric returned.
	MetricResults []*CurrentMetricResult `type:"list"`

	// A string returned in the response. Use the value returned in the response
	// as the value of the NextToken in a subsequent 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 NextToken must use the same request parameters as the
	// request that generated the token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCurrentMetricDataOutput) GoString 

func (s GetCurrentMetricDataOutput) GoString() string

GoString returns the string representation

func (*GetCurrentMetricDataOutput) SetDataSnapshotTime 

func (s *GetCurrentMetricDataOutput) SetDataSnapshotTime(v time.Time) *GetCurrentMetricDataOutput

SetDataSnapshotTime sets the DataSnapshotTime field's value.

func (*GetCurrentMetricDataOutput) SetMetricResults 

func (s *GetCurrentMetricDataOutput) SetMetricResults(v []*CurrentMetricResult) *GetCurrentMetricDataOutput

SetMetricResults sets the MetricResults field's value.

func (*GetCurrentMetricDataOutput) SetNextToken 

func (s *GetCurrentMetricDataOutput) SetNextToken(v string) *GetCurrentMetricDataOutput

SetNextToken sets the NextToken field's value.

func (GetCurrentMetricDataOutput) String 

func (s GetCurrentMetricDataOutput) String() string

String returns the string representation

type GetFederationTokenInput 

type GetFederationTokenInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetFederationTokenInput) GoString 

func (s GetFederationTokenInput) GoString() string

GoString returns the string representation

func (*GetFederationTokenInput) SetInstanceId 

func (s *GetFederationTokenInput) SetInstanceId(v string) *GetFederationTokenInput

SetInstanceId sets the InstanceId field's value.

func (GetFederationTokenInput) String 

func (s GetFederationTokenInput) String() string

String returns the string representation

func (*GetFederationTokenInput) Validate 

func (s *GetFederationTokenInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFederationTokenOutput 

type GetFederationTokenOutput struct {

	// The credentials to use for federation.
	Credentials *Credentials `type:"structure"`
	// contains filtered or unexported fields
}

func (GetFederationTokenOutput) GoString 

func (s GetFederationTokenOutput) GoString() string

GoString returns the string representation

func (*GetFederationTokenOutput) SetCredentials 

func (s *GetFederationTokenOutput) SetCredentials(v *Credentials) *GetFederationTokenOutput

SetCredentials sets the Credentials field's value.

func (GetFederationTokenOutput) String 

func (s GetFederationTokenOutput) String() string

String returns the string representation

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 StartTime timestamp.
	//
	// The time range between StartTime and EndTime must be less than 24 hours.
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" required:"true"`

	// A Filters object that contains a list of queue IDs or queue ARNs, up to 100,
	// or a list of Channels to use to filter the metrics returned in the response.
	// Metric data is retrieved only for the resources associated with the IDs,
	// ARNs, or Channels included in the filter. You can use both IDs and ARNs together
	// in a request. Only VOICE is supported for Channel.
	//
	// To find the ARN for a queue, open the queue you want to use in the Amazon
	// Connect Queue editor. The ARN for the queue is displayed in the address bar
	// as part of the URL. For example, the queue ARN is the set of characters at
	// the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61.
	// The queue ID is also included in the URL, and is the string after 'queue/'.
	//
	// Filters is a required field
	Filters *Filters `type:"structure" required:"true"`

	// The grouping applied to the metrics returned. For example, when results are
	// grouped by queueId, the metrics returned are grouped by queue. The values
	// returned apply to the metrics for each queue rather than aggregated for all
	// queues.
	//
	// The current version supports grouping by Queue
	//
	// If no Grouping is included in the request, a summary of HistoricalMetrics
	// for all queues is returned.
	Groupings []*string `type:"list"`

	// A list of HistoricalMetric objects that contain the metrics to retrieve with
	// the request.
	//
	// A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold,
	// and Unit.
	//
	// You must list each metric to retrieve data for in the request. For each historical
	// metric you include in the request, you must include a Unit and a Statistic.
	//
	// The following historical metrics are available:
	//
	// CONTACTS_QUEUEDUnit: COUNT
	//
	// Statistic: SUM
	//
	// CONTACTS_HANDLEDUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_ABANDONEDUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_CONSULTEDUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_AGENT_HUNG_UP_FIRSTUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_HANDLED_INCOMINGUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_HANDLED_OUTBOUNDUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_HOLD_ABANDONSUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_TRANSFERRED_INUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_TRANSFERRED_OUTUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_TRANSFERRED_IN_FROM_QUEUEUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_TRANSFERRED_OUT_FROM_QUEUEUnit: COUNT
	//
	// Statistics: SUM
	//
	// CALLBACK_CONTACTS_HANDLEDUnit: COUNT
	//
	// Statistics: SUM
	//
	// CALLBACK_CONTACTS_HANDLEDUnit: COUNT
	//
	// Statistics: SUM
	//
	// API_CONTACTS_HANDLEDUnit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_MISSEDUnit: COUNT
	//
	// Statistics: SUM
	//
	// OCCUPANCYUnit: PERCENT
	//
	// Statistics: AVG
	//
	// HANDLE_TIMEUnit: SECONDS
	//
	// Statistics: AVG
	//
	// AFTER_CONTACT_WORK_TIMEUnit: SECONDS
	//
	// Statistics: AVG
	//
	// QUEUED_TIMEUnit: SECONDS
	//
	// Statistics: MAX
	//
	// ABANDON_TIMEUnit: COUNT
	//
	// Statistics: SUM
	//
	// QUEUE_ANSWER_TIMEUnit: SECONDS
	//
	// Statistics: AVG
	//
	// HOLD_TIMEUnit: SECONDS
	//
	// Statistics: AVG
	//
	// INTERACTION_TIMEUnit: SECONDS
	//
	// Statistics: AVG
	//
	// INTERACTION_AND_HOLD_TIMEUnit: SECONDS
	//
	// Statistics: AVG
	//
	// SERVICE_LEVELUnit: PERCENT
	//
	// Statistics: AVG
	//
	// Threshold: Only "Less than" comparisons are supported, with the following
	// service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300,
	// 600
	//
	// HistoricalMetrics is a required field
	HistoricalMetrics []*HistoricalMetric `type:"list" required:"true"`

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// Indicates the maximum number of results to return per page in the response,
	// between 1-100.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `type:"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.
	//
	// StartTime cannot be earlier than 24 hours before the time of the request.
	// Historical metrics are available in Amazon Connect only for 24 hours.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (GetMetricDataInput) GoString 

func (s GetMetricDataInput) GoString() string

GoString returns the string representation

func (*GetMetricDataInput) SetEndTime 

func (s *GetMetricDataInput) SetEndTime(v time.Time) *GetMetricDataInput

SetEndTime sets the EndTime field's value.

func (*GetMetricDataInput) SetFilters 

func (s *GetMetricDataInput) SetFilters(v *Filters) *GetMetricDataInput

SetFilters sets the Filters field's value.

func (*GetMetricDataInput) SetGroupings 

func (s *GetMetricDataInput) SetGroupings(v []*string) *GetMetricDataInput

SetGroupings sets the Groupings field's value.

func (*GetMetricDataInput) SetHistoricalMetrics 

func (s *GetMetricDataInput) SetHistoricalMetrics(v []*HistoricalMetric) *GetMetricDataInput

SetHistoricalMetrics sets the HistoricalMetrics field's value.

func (*GetMetricDataInput) SetInstanceId 

func (s *GetMetricDataInput) SetInstanceId(v string) *GetMetricDataInput

SetInstanceId sets the InstanceId field's value.

func (*GetMetricDataInput) SetMaxResults 

func (s *GetMetricDataInput) SetMaxResults(v int64) *GetMetricDataInput

SetMaxResults sets the MaxResults field's value.

func (*GetMetricDataInput) SetNextToken 

func (s *GetMetricDataInput) SetNextToken(v string) *GetMetricDataInput

SetNextToken sets the NextToken field's value.

func (*GetMetricDataInput) SetStartTime 

func (s *GetMetricDataInput) SetStartTime(v time.Time) *GetMetricDataInput

SetStartTime sets the StartTime field's value.

func (GetMetricDataInput) String 

func (s GetMetricDataInput) String() string

String returns the string representation

func (*GetMetricDataInput) Validate 

func (s *GetMetricDataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMetricDataOutput 

type GetMetricDataOutput struct {

	// A list of HistoricalMetricResult objects, organized by Dimensions, which
	// is the ID of the resource specified in the Filters used for the request.
	// The metrics are combined with the metrics included in Collections, which
	// is a list of HisotricalMetricData objects.
	//
	// If no Grouping is specified in the request, Collections includes summary
	// data for the HistoricalMetrics.
	MetricResults []*HistoricalMetricResult `type:"list"`

	// A string returned in the response. Use the value returned in the response
	// as the value of the NextToken in a subsequent 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 NextToken must use the same request parameters as the
	// request that generated the token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetMetricDataOutput) GoString 

func (s GetMetricDataOutput) GoString() string

GoString returns the string representation

func (*GetMetricDataOutput) SetMetricResults 

func (s *GetMetricDataOutput) SetMetricResults(v []*HistoricalMetricResult) *GetMetricDataOutput

SetMetricResults sets the MetricResults field's value.

func (*GetMetricDataOutput) SetNextToken 

func (s *GetMetricDataOutput) SetNextToken(v string) *GetMetricDataOutput

SetNextToken sets the NextToken field's value.

func (GetMetricDataOutput) String 

func (s GetMetricDataOutput) String() string

String returns the string representation

type HierarchyGroup 

type HierarchyGroup struct {

	// The Amazon Resource Name (ARN) for the hierarchy group.
	Arn *string `type:"string"`

	// A HierarchyPath object that contains information about the levels in the
	// hierarchy group.
	HierarchyPath *HierarchyPath `type:"structure"`

	// The identifier for the hierarchy group.
	Id *string `type:"string"`

	// The identifier for the level in the hierarchy group.
	LevelId *string `type:"string"`

	// The name of the hierarchy group in your instance.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A HierarchyGroup object that contains information about a hierarchy group in your Amazon Connect instance.

func (HierarchyGroup) GoString 

func (s HierarchyGroup) GoString() string

GoString returns the string representation

func (*HierarchyGroup) SetArn 

func (s *HierarchyGroup) SetArn(v string) *HierarchyGroup

SetArn sets the Arn field's value.

func (*HierarchyGroup) SetHierarchyPath 

func (s *HierarchyGroup) SetHierarchyPath(v *HierarchyPath) *HierarchyGroup

SetHierarchyPath sets the HierarchyPath field's value.

func (*HierarchyGroup) SetId 

func (s *HierarchyGroup) SetId(v string) *HierarchyGroup

SetId sets the Id field's value.

func (*HierarchyGroup) SetLevelId 

func (s *HierarchyGroup) SetLevelId(v string) *HierarchyGroup

SetLevelId sets the LevelId field's value.

func (*HierarchyGroup) SetName 

func (s *HierarchyGroup) SetName(v string) *HierarchyGroup

SetName sets the Name field's value.

func (HierarchyGroup) String 

func (s HierarchyGroup) String() string

String returns the string representation

type HierarchyGroupSummary 

type HierarchyGroupSummary struct {

	// The ARN for the hierarchy group.
	Arn *string `type:"string"`

	// The identifier of the hierarchy group.
	Id *string `type:"string"`

	// The name of the hierarchy group.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A HierarchyGroupSummary object that contains information about the hierarchy group, including ARN, Id, and Name.

func (HierarchyGroupSummary) GoString 

func (s HierarchyGroupSummary) GoString() string

GoString returns the string representation

func (*HierarchyGroupSummary) SetArn 

func (s *HierarchyGroupSummary) SetArn(v string) *HierarchyGroupSummary

SetArn sets the Arn field's value.

func (*HierarchyGroupSummary) SetId 

func (s *HierarchyGroupSummary) SetId(v string) *HierarchyGroupSummary

SetId sets the Id field's value.

func (*HierarchyGroupSummary) SetName 

func (s *HierarchyGroupSummary) SetName(v string) *HierarchyGroupSummary

SetName sets the Name field's value.

func (HierarchyGroupSummary) String 

func (s HierarchyGroupSummary) String() string

String returns the string representation

type HierarchyLevel 

type HierarchyLevel struct {

	// The ARN for the hierarchy group level.
	Arn *string `type:"string"`

	// The identifier for the hierarchy group level.
	Id *string `type:"string"`

	// The name of the hierarchy group level.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A HierarchyLevel object that contains information about the levels in a hierarchy group, including ARN, Id, and Name.

func (HierarchyLevel) GoString 

func (s HierarchyLevel) GoString() string

GoString returns the string representation

func (*HierarchyLevel) SetArn 

func (s *HierarchyLevel) SetArn(v string) *HierarchyLevel

SetArn sets the Arn field's value.

func (*HierarchyLevel) SetId 

func (s *HierarchyLevel) SetId(v string) *HierarchyLevel

SetId sets the Id field's value.

func (*HierarchyLevel) SetName 

func (s *HierarchyLevel) SetName(v string) *HierarchyLevel

SetName sets the Name field's value.

func (HierarchyLevel) String 

func (s HierarchyLevel) String() string

String returns the string representation

type HierarchyPath 

type HierarchyPath struct {

	// A HierarchyGroupSummary object that contains information about the level
	// of the hierarchy group, including ARN, Id, and Name.
	LevelFive *HierarchyGroupSummary `type:"structure"`

	// A HierarchyGroupSummary object that contains information about the level
	// of the hierarchy group, including ARN, Id, and Name.
	LevelFour *HierarchyGroupSummary `type:"structure"`

	// A HierarchyGroupSummary object that contains information about the level
	// of the hierarchy group, including ARN, Id, and Name.
	LevelOne *HierarchyGroupSummary `type:"structure"`

	// A HierarchyGroupSummary object that contains information about the level
	// of the hierarchy group, including ARN, Id, and Name.
	LevelThree *HierarchyGroupSummary `type:"structure"`

	// A HierarchyGroupSummary object that contains information about the level
	// of the hierarchy group, including ARN, Id, and Name.
	LevelTwo *HierarchyGroupSummary `type:"structure"`
	// contains filtered or unexported fields
}

A HierarchyPath object that contains information about the levels of the hierarchy group.

func (HierarchyPath) GoString 

func (s HierarchyPath) GoString() string

GoString returns the string representation

func (*HierarchyPath) SetLevelFive 

func (s *HierarchyPath) SetLevelFive(v *HierarchyGroupSummary) *HierarchyPath

SetLevelFive sets the LevelFive field's value.

func (*HierarchyPath) SetLevelFour 

func (s *HierarchyPath) SetLevelFour(v *HierarchyGroupSummary) *HierarchyPath

SetLevelFour sets the LevelFour field's value.

func (*HierarchyPath) SetLevelOne 

func (s *HierarchyPath) SetLevelOne(v *HierarchyGroupSummary) *HierarchyPath

SetLevelOne sets the LevelOne field's value.

func (*HierarchyPath) SetLevelThree 

func (s *HierarchyPath) SetLevelThree(v *HierarchyGroupSummary) *HierarchyPath

SetLevelThree sets the LevelThree field's value.

func (*HierarchyPath) SetLevelTwo 

func (s *HierarchyPath) SetLevelTwo(v *HierarchyGroupSummary) *HierarchyPath

SetLevelTwo sets the LevelTwo field's value.

func (HierarchyPath) String 

func (s HierarchyPath) String() string

String returns the string representation

type HierarchyStructure 

type HierarchyStructure struct {

	// A HierarchyLevel object that contains information about the hierarchy group
	// level.
	LevelFive *HierarchyLevel `type:"structure"`

	// A HierarchyLevel object that contains information about the hierarchy group
	// level.
	LevelFour *HierarchyLevel `type:"structure"`

	// A HierarchyLevel object that contains information about the hierarchy group
	// level.
	LevelOne *HierarchyLevel `type:"structure"`

	// A HierarchyLevel object that contains information about the hierarchy group
	// level.
	LevelThree *HierarchyLevel `type:"structure"`

	// A HierarchyLevel object that contains information about the hierarchy group
	// level.
	LevelTwo *HierarchyLevel `type:"structure"`
	// contains filtered or unexported fields
}

A HierarchyStructure object that contains information about the hierarchy group structure.

func (HierarchyStructure) GoString 

func (s HierarchyStructure) GoString() string

GoString returns the string representation

func (*HierarchyStructure) SetLevelFive 

func (s *HierarchyStructure) SetLevelFive(v *HierarchyLevel) *HierarchyStructure

SetLevelFive sets the LevelFive field's value.

func (*HierarchyStructure) SetLevelFour 

func (s *HierarchyStructure) SetLevelFour(v *HierarchyLevel) *HierarchyStructure

SetLevelFour sets the LevelFour field's value.

func (*HierarchyStructure) SetLevelOne 

func (s *HierarchyStructure) SetLevelOne(v *HierarchyLevel) *HierarchyStructure

SetLevelOne sets the LevelOne field's value.

func (*HierarchyStructure) SetLevelThree 

func (s *HierarchyStructure) SetLevelThree(v *HierarchyLevel) *HierarchyStructure

SetLevelThree sets the LevelThree field's value.

func (*HierarchyStructure) SetLevelTwo 

func (s *HierarchyStructure) SetLevelTwo(v *HierarchyLevel) *HierarchyStructure

SetLevelTwo sets the LevelTwo field's value.

func (HierarchyStructure) String 

func (s HierarchyStructure) String() string

String returns the string representation

type HistoricalMetric 

type HistoricalMetric struct {

	// The name of the historical metric.
	Name *string `type:"string" enum:"HistoricalMetricName"`

	// The statistic for the metric.
	Statistic *string `type:"string" enum:"Statistic"`

	// The threshold for the metric, used with service level metrics.
	Threshold *Threshold `type:"structure"`

	// The unit for the metric.
	Unit *string `type:"string" enum:"Unit"`
	// contains filtered or unexported fields
}

A HistoricalMetric object that contains the Name, Unit, Statistic, and Threshold for the metric.

func (HistoricalMetric) GoString 

func (s HistoricalMetric) GoString() string

GoString returns the string representation

func (*HistoricalMetric) SetName 

func (s *HistoricalMetric) SetName(v string) *HistoricalMetric

SetName sets the Name field's value.

func (*HistoricalMetric) SetStatistic 

func (s *HistoricalMetric) SetStatistic(v string) *HistoricalMetric

SetStatistic sets the Statistic field's value.

func (*HistoricalMetric) SetThreshold 

func (s *HistoricalMetric) SetThreshold(v *Threshold) *HistoricalMetric

SetThreshold sets the Threshold field's value.

func (*HistoricalMetric) SetUnit 

func (s *HistoricalMetric) SetUnit(v string) *HistoricalMetric

SetUnit sets the Unit field's value.

func (HistoricalMetric) String 

func (s HistoricalMetric) String() string

String returns the string representation

type HistoricalMetricData 

type HistoricalMetricData struct {

	// A HistoricalMetric object.
	Metric *HistoricalMetric `type:"structure"`

	// The Value of the metric.
	Value *float64 `type:"double"`
	// contains filtered or unexported fields
}

A HistoricalMetricData object than contains a Metric and a Value.

func (HistoricalMetricData) GoString 

func (s HistoricalMetricData) GoString() string

GoString returns the string representation

func (*HistoricalMetricData) SetMetric 

func (s *HistoricalMetricData) SetMetric(v *HistoricalMetric) *HistoricalMetricData

SetMetric sets the Metric field's value.

func (*HistoricalMetricData) SetValue 

func (s *HistoricalMetricData) SetValue(v float64) *HistoricalMetricData

SetValue sets the Value field's value.

func (HistoricalMetricData) String 

func (s HistoricalMetricData) String() string

String returns the string representation

type HistoricalMetricResult 

type HistoricalMetricResult struct {

	// A list of HistoricalMetricData objects.
	Collections []*HistoricalMetricData `type:"list"`

	// The Dimensions for the metrics.
	Dimensions *Dimensions `type:"structure"`
	// contains filtered or unexported fields
}

The metrics data returned from a GetMetricData operation.

func (HistoricalMetricResult) GoString 

func (s HistoricalMetricResult) GoString() string

GoString returns the string representation

func (*HistoricalMetricResult) SetCollections 

func (s *HistoricalMetricResult) SetCollections(v []*HistoricalMetricData) *HistoricalMetricResult

SetCollections sets the Collections field's value.

func (*HistoricalMetricResult) SetDimensions 

func (s *HistoricalMetricResult) SetDimensions(v *Dimensions) *HistoricalMetricResult

SetDimensions sets the Dimensions field's value.

func (HistoricalMetricResult) String 

func (s HistoricalMetricResult) String() string

String returns the string representation

type ListRoutingProfilesInput 

type ListRoutingProfilesInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The maximum number of routing profiles to return in the response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListRoutingProfilesInput) GoString 

func (s ListRoutingProfilesInput) GoString() string

GoString returns the string representation

func (*ListRoutingProfilesInput) SetInstanceId 

func (s *ListRoutingProfilesInput) SetInstanceId(v string) *ListRoutingProfilesInput

SetInstanceId sets the InstanceId field's value.

func (*ListRoutingProfilesInput) SetMaxResults 

func (s *ListRoutingProfilesInput) SetMaxResults(v int64) *ListRoutingProfilesInput

SetMaxResults sets the MaxResults field's value.

func (*ListRoutingProfilesInput) SetNextToken 

func (s *ListRoutingProfilesInput) SetNextToken(v string) *ListRoutingProfilesInput

SetNextToken sets the NextToken field's value.

func (ListRoutingProfilesInput) String 

func (s ListRoutingProfilesInput) String() string

String returns the string representation

func (*ListRoutingProfilesInput) Validate 

func (s *ListRoutingProfilesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRoutingProfilesOutput 

type ListRoutingProfilesOutput struct {

	// A string returned in the response. Use the value returned in the response
	// as the value of the NextToken in a subsequent request to retrieve the next
	// set of results.
	NextToken *string `type:"string"`

	// An array of RoutingProfileSummary objects that include the ARN, Id, and Name
	// of the routing profile.
	RoutingProfileSummaryList []*RoutingProfileSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListRoutingProfilesOutput) GoString 

func (s ListRoutingProfilesOutput) GoString() string

GoString returns the string representation

func (*ListRoutingProfilesOutput) SetNextToken 

func (s *ListRoutingProfilesOutput) SetNextToken(v string) *ListRoutingProfilesOutput

SetNextToken sets the NextToken field's value.

func (*ListRoutingProfilesOutput) SetRoutingProfileSummaryList 

func (s *ListRoutingProfilesOutput) SetRoutingProfileSummaryList(v []*RoutingProfileSummary) *ListRoutingProfilesOutput

SetRoutingProfileSummaryList sets the RoutingProfileSummaryList field's value.

func (ListRoutingProfilesOutput) String 

func (s ListRoutingProfilesOutput) String() string

String returns the string representation

type ListSecurityProfilesInput 

type ListSecurityProfilesInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The maximum number of security profiles to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListSecurityProfilesInput) GoString 

func (s ListSecurityProfilesInput) GoString() string

GoString returns the string representation

func (*ListSecurityProfilesInput) SetInstanceId 

func (s *ListSecurityProfilesInput) SetInstanceId(v string) *ListSecurityProfilesInput

SetInstanceId sets the InstanceId field's value.

func (*ListSecurityProfilesInput) SetMaxResults 

func (s *ListSecurityProfilesInput) SetMaxResults(v int64) *ListSecurityProfilesInput

SetMaxResults sets the MaxResults field's value.

func (*ListSecurityProfilesInput) SetNextToken 

func (s *ListSecurityProfilesInput) SetNextToken(v string) *ListSecurityProfilesInput

SetNextToken sets the NextToken field's value.

func (ListSecurityProfilesInput) String 

func (s ListSecurityProfilesInput) String() string

String returns the string representation

func (*ListSecurityProfilesInput) Validate 

func (s *ListSecurityProfilesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSecurityProfilesOutput 

type ListSecurityProfilesOutput struct {

	// A string returned in the response. Use the value returned in the response
	// as the value of the NextToken in a subsequent request to retrieve the next
	// set of results.
	NextToken *string `type:"string"`

	// An array of SecurityProfileSummary objects.
	SecurityProfileSummaryList []*SecurityProfileSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListSecurityProfilesOutput) GoString 

func (s ListSecurityProfilesOutput) GoString() string

GoString returns the string representation

func (*ListSecurityProfilesOutput) SetNextToken 

func (s *ListSecurityProfilesOutput) SetNextToken(v string) *ListSecurityProfilesOutput

SetNextToken sets the NextToken field's value.

func (*ListSecurityProfilesOutput) SetSecurityProfileSummaryList 

func (s *ListSecurityProfilesOutput) SetSecurityProfileSummaryList(v []*SecurityProfileSummary) *ListSecurityProfilesOutput

SetSecurityProfileSummaryList sets the SecurityProfileSummaryList field's value.

func (ListSecurityProfilesOutput) String 

func (s ListSecurityProfilesOutput) String() string

String returns the string representation

type ListUserHierarchyGroupsInput 

type ListUserHierarchyGroupsInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The maximum number of hierarchy groups to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListUserHierarchyGroupsInput) GoString 

func (s ListUserHierarchyGroupsInput) GoString() string

GoString returns the string representation

func (*ListUserHierarchyGroupsInput) SetInstanceId 

func (s *ListUserHierarchyGroupsInput) SetInstanceId(v string) *ListUserHierarchyGroupsInput

SetInstanceId sets the InstanceId field's value.

func (*ListUserHierarchyGroupsInput) SetMaxResults 

func (s *ListUserHierarchyGroupsInput) SetMaxResults(v int64) *ListUserHierarchyGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListUserHierarchyGroupsInput) SetNextToken 

func (s *ListUserHierarchyGroupsInput) SetNextToken(v string) *ListUserHierarchyGroupsInput

SetNextToken sets the NextToken field's value.

func (ListUserHierarchyGroupsInput) String 

func (s ListUserHierarchyGroupsInput) String() string

String returns the string representation

func (*ListUserHierarchyGroupsInput) Validate 

func (s *ListUserHierarchyGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListUserHierarchyGroupsOutput 

type ListUserHierarchyGroupsOutput struct {

	// A string returned in the response. Use the value returned in the response
	// as the value of the NextToken in a subsequent request to retrieve the next
	// set of results.
	NextToken *string `type:"string"`

	// An array of HierarchyGroupSummary objects.
	UserHierarchyGroupSummaryList []*HierarchyGroupSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListUserHierarchyGroupsOutput) GoString 

func (s ListUserHierarchyGroupsOutput) GoString() string

GoString returns the string representation

func (*ListUserHierarchyGroupsOutput) SetNextToken 

func (s *ListUserHierarchyGroupsOutput) SetNextToken(v string) *ListUserHierarchyGroupsOutput

SetNextToken sets the NextToken field's value.

func (*ListUserHierarchyGroupsOutput) SetUserHierarchyGroupSummaryList 

func (s *ListUserHierarchyGroupsOutput) SetUserHierarchyGroupSummaryList(v []*HierarchyGroupSummary) *ListUserHierarchyGroupsOutput

SetUserHierarchyGroupSummaryList sets the UserHierarchyGroupSummaryList field's value.

func (ListUserHierarchyGroupsOutput) String 

func (s ListUserHierarchyGroupsOutput) String() string

String returns the string representation

type ListUsersInput 

type ListUsersInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListUsersInput) GoString 

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (*ListUsersInput) SetInstanceId 

func (s *ListUsersInput) SetInstanceId(v string) *ListUsersInput

SetInstanceId sets the InstanceId field's value.

func (*ListUsersInput) SetMaxResults 

func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNextToken 

func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput

SetNextToken sets the NextToken field's value.

func (ListUsersInput) String 

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate 

func (s *ListUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListUsersOutput 

type ListUsersOutput struct {

	// A string returned in the response. Use the value returned in the response
	// as the value of the NextToken in a subsequent request to retrieve the next
	// set of results.
	NextToken *string `type:"string"`

	// An array of UserSummary objects that contain information about the users
	// in your instance.
	UserSummaryList []*UserSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListUsersOutput) GoString 

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (*ListUsersOutput) SetNextToken 

func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput

SetNextToken sets the NextToken field's value.

func (*ListUsersOutput) SetUserSummaryList 

func (s *ListUsersOutput) SetUserSummaryList(v []*UserSummary) *ListUsersOutput

SetUserSummaryList sets the UserSummaryList field's value.

func (ListUsersOutput) String 

func (s ListUsersOutput) String() string

String returns the string representation

type QueueReference 

type QueueReference struct {

	// The Amazon Resource Name (ARN) of queue.
	Arn *string `type:"string"`

	// The ID of the queue associated with the metrics returned.
	Id *string `type:"string"`
	// contains filtered or unexported fields
}

A QueueReference object that contains the the QueueId and ARN for the queue resource for which metrics are returned.

func (QueueReference) GoString 

func (s QueueReference) GoString() string

GoString returns the string representation

func (*QueueReference) SetArn 

func (s *QueueReference) SetArn(v string) *QueueReference

SetArn sets the Arn field's value.

func (*QueueReference) SetId 

func (s *QueueReference) SetId(v string) *QueueReference

SetId sets the Id field's value.

func (QueueReference) String 

func (s QueueReference) String() string

String returns the string representation

type RoutingProfileSummary 

type RoutingProfileSummary struct {

	// The ARN of the routing profile.
	Arn *string `type:"string"`

	// The identifier of the routing profile.
	Id *string `type:"string"`

	// The name of the routing profile.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A RoutingProfileSummary object that contains information about a routing profile, including ARN, Id, and Name.

func (RoutingProfileSummary) GoString 

func (s RoutingProfileSummary) GoString() string

GoString returns the string representation

func (*RoutingProfileSummary) SetArn 

func (s *RoutingProfileSummary) SetArn(v string) *RoutingProfileSummary

SetArn sets the Arn field's value.

func (*RoutingProfileSummary) SetId 

func (s *RoutingProfileSummary) SetId(v string) *RoutingProfileSummary

SetId sets the Id field's value.

func (*RoutingProfileSummary) SetName 

func (s *RoutingProfileSummary) SetName(v string) *RoutingProfileSummary

SetName sets the Name field's value.

func (RoutingProfileSummary) String 

func (s RoutingProfileSummary) String() string

String returns the string representation

type SecurityProfileSummary 

type SecurityProfileSummary struct {

	// The ARN of the security profile.
	Arn *string `type:"string"`

	// The identifier of the security profile.
	Id *string `type:"string"`

	// The name of the security profile.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A SecurityProfileSummary object that contains information about a security profile, including ARN, Id, Name.

func (SecurityProfileSummary) GoString 

func (s SecurityProfileSummary) GoString() string

GoString returns the string representation

func (*SecurityProfileSummary) SetArn 

func (s *SecurityProfileSummary) SetArn(v string) *SecurityProfileSummary

SetArn sets the Arn field's value.

func (*SecurityProfileSummary) SetId 

func (s *SecurityProfileSummary) SetId(v string) *SecurityProfileSummary

SetId sets the Id field's value.

func (*SecurityProfileSummary) SetName 

func (s *SecurityProfileSummary) SetName(v string) *SecurityProfileSummary

SetName sets the Name field's value.

func (SecurityProfileSummary) String 

func (s SecurityProfileSummary) String() string

String returns the string representation

type StartOutboundVoiceContactInput 

type StartOutboundVoiceContactInput struct {

	// Specify a custom key-value pair using an attribute map. The attributes are
	// standard Amazon Connect attributes, and can be accessed in contact flows
	// just like any other contact attributes.
	//
	// 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.
	//
	// For example, if you want play a greeting when the customer answers the call,
	// you can pass the customer name in attributes similar to the following:
	Attributes map[string]*string `type:"map"`

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. The token is valid for 7 days after creation. If a contact
	// is already started, the contact ID is returned. If the contact is disconnected,
	// a new contact is started.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// The identifier for the contact flow to connect the outbound call to.
	//
	// To find the ContactFlowId, open the contact flow you want to use in the Amazon
	// Connect contact flow editor. The ID for the contact flow is displayed in
	// the address bar as part of the URL. For example, the contact flow ID is the
	// set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.
	//
	// ContactFlowId is a required field
	ContactFlowId *string `type:"string" required:"true"`

	// The phone number of the customer in E.164 format.
	//
	// DestinationPhoneNumber is a required field
	DestinationPhoneNumber *string `type:"string" required:"true"`

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `min:"1" type:"string" required:"true"`

	// The queue to add the call to. 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 used will be the queue defined in the contact flow.
	//
	// To find the QueueId, open the queue you want to use in the Amazon Connect
	// Queue editor. The ID for the queue is displayed in the address bar as part
	// of the URL. For example, the queue ID is the set of characters at the end
	// of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.
	QueueId *string `type:"string"`

	// The phone number, in E.164 format, associated with your Amazon Connect instance
	// to use for the outbound call.
	SourcePhoneNumber *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartOutboundVoiceContactInput) GoString 

func (s StartOutboundVoiceContactInput) GoString() string

GoString returns the string representation

func (*StartOutboundVoiceContactInput) SetAttributes 

func (s *StartOutboundVoiceContactInput) SetAttributes(v map[string]*string) *StartOutboundVoiceContactInput

SetAttributes sets the Attributes field's value.

func (*StartOutboundVoiceContactInput) SetClientToken 

func (s *StartOutboundVoiceContactInput) SetClientToken(v string) *StartOutboundVoiceContactInput

SetClientToken sets the ClientToken field's value.

func (*StartOutboundVoiceContactInput) SetContactFlowId 

func (s *StartOutboundVoiceContactInput) SetContactFlowId(v string) *StartOutboundVoiceContactInput

SetContactFlowId sets the ContactFlowId field's value.

func (*StartOutboundVoiceContactInput) SetDestinationPhoneNumber 

func (s *StartOutboundVoiceContactInput) SetDestinationPhoneNumber(v string) *StartOutboundVoiceContactInput

SetDestinationPhoneNumber sets the DestinationPhoneNumber field's value.

func (*StartOutboundVoiceContactInput) SetInstanceId 

func (s *StartOutboundVoiceContactInput) SetInstanceId(v string) *StartOutboundVoiceContactInput

SetInstanceId sets the InstanceId field's value.

func (*StartOutboundVoiceContactInput) SetQueueId 

func (s *StartOutboundVoiceContactInput) SetQueueId(v string) *StartOutboundVoiceContactInput

SetQueueId sets the QueueId field's value.

func (*StartOutboundVoiceContactInput) SetSourcePhoneNumber 

func (s *StartOutboundVoiceContactInput) SetSourcePhoneNumber(v string) *StartOutboundVoiceContactInput

SetSourcePhoneNumber sets the SourcePhoneNumber field's value.

func (StartOutboundVoiceContactInput) String 

func (s StartOutboundVoiceContactInput) String() string

String returns the string representation

func (*StartOutboundVoiceContactInput) Validate 

func (s *StartOutboundVoiceContactInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartOutboundVoiceContactOutput 

type StartOutboundVoiceContactOutput struct {

	// The unique identifier of this contact within your Amazon Connect instance.
	ContactId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartOutboundVoiceContactOutput) GoString 

func (s StartOutboundVoiceContactOutput) GoString() string

GoString returns the string representation

func (*StartOutboundVoiceContactOutput) SetContactId 

func (s *StartOutboundVoiceContactOutput) SetContactId(v string) *StartOutboundVoiceContactOutput

SetContactId sets the ContactId field's value.

func (StartOutboundVoiceContactOutput) String 

func (s StartOutboundVoiceContactOutput) String() string

String returns the string representation

type StopContactInput 

type StopContactInput struct {

	// The unique identifier of the contact to end.
	//
	// ContactId is a required field
	ContactId *string `min:"1" type:"string" required:"true"`

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopContactInput) GoString 

func (s StopContactInput) GoString() string

GoString returns the string representation

func (*StopContactInput) SetContactId 

func (s *StopContactInput) SetContactId(v string) *StopContactInput

SetContactId sets the ContactId field's value.

func (*StopContactInput) SetInstanceId 

func (s *StopContactInput) SetInstanceId(v string) *StopContactInput

SetInstanceId sets the InstanceId field's value.

func (StopContactInput) String 

func (s StopContactInput) String() string

String returns the string representation

func (*StopContactInput) Validate 

func (s *StopContactInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopContactOutput 

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

func (StopContactOutput) GoString 

func (s StopContactOutput) GoString() string

GoString returns the string representation

func (StopContactOutput) String 

func (s StopContactOutput) String() string

String returns the string representation

type Threshold 

type Threshold struct {

	// The Threshold to use to compare service level metrics to. Only "Less than"
	// (LT) comparisons are supported.
	Comparison *string `type:"string" enum:"Comparison"`

	// The value of the threshold to compare the metric to. Only "Less than" (LT)
	// comparisons are supported.
	ThresholdValue *float64 `type:"double"`
	// contains filtered or unexported fields
}

A Threshold object that includes a comparison and ThresholdValue to compare to. Used with service level metrics.

func (Threshold) GoString 

func (s Threshold) GoString() string

GoString returns the string representation

func (*Threshold) SetComparison 

func (s *Threshold) SetComparison(v string) *Threshold

SetComparison sets the Comparison field's value.

func (*Threshold) SetThresholdValue 

func (s *Threshold) SetThresholdValue(v float64) *Threshold

SetThresholdValue sets the ThresholdValue field's value.

func (Threshold) String 

func (s Threshold) String() string

String returns the string representation

type UpdateContactAttributesInput 

type UpdateContactAttributesInput struct {

	// Specify a custom key-value pair using an attribute map. The attributes are
	// standard Amazon Connect attributes, and can be accessed in contact flows
	// just like any other contact attributes.
	//
	// 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 is a required field
	Attributes map[string]*string `type:"map" required:"true"`

	// The unique identifier of the contact for which to update attributes. This
	// is the identifier for the contact associated with the first interaction with
	// the contact center.
	//
	// InitialContactId is a required field
	InitialContactId *string `min:"1" type:"string" required:"true"`

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateContactAttributesInput) GoString 

func (s UpdateContactAttributesInput) GoString() string

GoString returns the string representation

func (*UpdateContactAttributesInput) SetAttributes 

func (s *UpdateContactAttributesInput) SetAttributes(v map[string]*string) *UpdateContactAttributesInput

SetAttributes sets the Attributes field's value.

func (*UpdateContactAttributesInput) SetInitialContactId 

func (s *UpdateContactAttributesInput) SetInitialContactId(v string) *UpdateContactAttributesInput

SetInitialContactId sets the InitialContactId field's value.

func (*UpdateContactAttributesInput) SetInstanceId 

func (s *UpdateContactAttributesInput) SetInstanceId(v string) *UpdateContactAttributesInput

SetInstanceId sets the InstanceId field's value.

func (UpdateContactAttributesInput) String 

func (s UpdateContactAttributesInput) String() string

String returns the string representation

func (*UpdateContactAttributesInput) Validate 

func (s *UpdateContactAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateContactAttributesOutput 

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

func (UpdateContactAttributesOutput) GoString 

func (s UpdateContactAttributesOutput) GoString() string

GoString returns the string representation

func (UpdateContactAttributesOutput) String 

func (s UpdateContactAttributesOutput) String() string

String returns the string representation

type UpdateUserHierarchyInput 

type UpdateUserHierarchyInput struct {

	// The identifier for the hierarchy group to assign to the user.
	HierarchyGroupId *string `type:"string"`

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The identifier of the user account to assign the hierarchy group to.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserHierarchyInput) GoString 

func (s UpdateUserHierarchyInput) GoString() string

GoString returns the string representation

func (*UpdateUserHierarchyInput) SetHierarchyGroupId 

func (s *UpdateUserHierarchyInput) SetHierarchyGroupId(v string) *UpdateUserHierarchyInput

SetHierarchyGroupId sets the HierarchyGroupId field's value.

func (*UpdateUserHierarchyInput) SetInstanceId 

func (s *UpdateUserHierarchyInput) SetInstanceId(v string) *UpdateUserHierarchyInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateUserHierarchyInput) SetUserId 

func (s *UpdateUserHierarchyInput) SetUserId(v string) *UpdateUserHierarchyInput

SetUserId sets the UserId field's value.

func (UpdateUserHierarchyInput) String 

func (s UpdateUserHierarchyInput) String() string

String returns the string representation

func (*UpdateUserHierarchyInput) Validate 

func (s *UpdateUserHierarchyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateUserHierarchyOutput 

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

func (UpdateUserHierarchyOutput) GoString 

func (s UpdateUserHierarchyOutput) GoString() string

GoString returns the string representation

func (UpdateUserHierarchyOutput) String 

func (s UpdateUserHierarchyOutput) String() string

String returns the string representation

type UpdateUserIdentityInfoInput 

type UpdateUserIdentityInfoInput struct {

	// A UserIdentityInfo object.
	//
	// IdentityInfo is a required field
	IdentityInfo *UserIdentityInfo `type:"structure" required:"true"`

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The identifier for the user account to update identity information for.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserIdentityInfoInput) GoString 

func (s UpdateUserIdentityInfoInput) GoString() string

GoString returns the string representation

func (*UpdateUserIdentityInfoInput) SetIdentityInfo 

func (s *UpdateUserIdentityInfoInput) SetIdentityInfo(v *UserIdentityInfo) *UpdateUserIdentityInfoInput

SetIdentityInfo sets the IdentityInfo field's value.

func (*UpdateUserIdentityInfoInput) SetInstanceId 

func (s *UpdateUserIdentityInfoInput) SetInstanceId(v string) *UpdateUserIdentityInfoInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateUserIdentityInfoInput) SetUserId 

func (s *UpdateUserIdentityInfoInput) SetUserId(v string) *UpdateUserIdentityInfoInput

SetUserId sets the UserId field's value.

func (UpdateUserIdentityInfoInput) String 

func (s UpdateUserIdentityInfoInput) String() string

String returns the string representation

func (*UpdateUserIdentityInfoInput) Validate 

func (s *UpdateUserIdentityInfoInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateUserIdentityInfoOutput 

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

func (UpdateUserIdentityInfoOutput) GoString 

func (s UpdateUserIdentityInfoOutput) GoString() string

GoString returns the string representation

func (UpdateUserIdentityInfoOutput) String 

func (s UpdateUserIdentityInfoOutput) String() string

String returns the string representation

type UpdateUserPhoneConfigInput 

type UpdateUserPhoneConfigInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit,
	// AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user.
	//
	// PhoneConfig is a required field
	PhoneConfig *UserPhoneConfig `type:"structure" required:"true"`

	// The identifier for the user account to change phone settings for.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserPhoneConfigInput) GoString 

func (s UpdateUserPhoneConfigInput) GoString() string

GoString returns the string representation

func (*UpdateUserPhoneConfigInput) SetInstanceId 

func (s *UpdateUserPhoneConfigInput) SetInstanceId(v string) *UpdateUserPhoneConfigInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateUserPhoneConfigInput) SetPhoneConfig 

func (s *UpdateUserPhoneConfigInput) SetPhoneConfig(v *UserPhoneConfig) *UpdateUserPhoneConfigInput

SetPhoneConfig sets the PhoneConfig field's value.

func (*UpdateUserPhoneConfigInput) SetUserId 

func (s *UpdateUserPhoneConfigInput) SetUserId(v string) *UpdateUserPhoneConfigInput

SetUserId sets the UserId field's value.

func (UpdateUserPhoneConfigInput) String 

func (s UpdateUserPhoneConfigInput) String() string

String returns the string representation

func (*UpdateUserPhoneConfigInput) Validate 

func (s *UpdateUserPhoneConfigInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateUserPhoneConfigOutput 

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

func (UpdateUserPhoneConfigOutput) GoString 

func (s UpdateUserPhoneConfigOutput) GoString() string

GoString returns the string representation

func (UpdateUserPhoneConfigOutput) String 

func (s UpdateUserPhoneConfigOutput) String() string

String returns the string representation

type UpdateUserRoutingProfileInput 

type UpdateUserRoutingProfileInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The identifier of the routing profile to assign to the user.
	//
	// RoutingProfileId is a required field
	RoutingProfileId *string `type:"string" required:"true"`

	// The identifier for the user account to assign the routing profile to.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserRoutingProfileInput) GoString 

func (s UpdateUserRoutingProfileInput) GoString() string

GoString returns the string representation

func (*UpdateUserRoutingProfileInput) SetInstanceId 

func (s *UpdateUserRoutingProfileInput) SetInstanceId(v string) *UpdateUserRoutingProfileInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateUserRoutingProfileInput) SetRoutingProfileId 

func (s *UpdateUserRoutingProfileInput) SetRoutingProfileId(v string) *UpdateUserRoutingProfileInput

SetRoutingProfileId sets the RoutingProfileId field's value.

func (*UpdateUserRoutingProfileInput) SetUserId 

func (s *UpdateUserRoutingProfileInput) SetUserId(v string) *UpdateUserRoutingProfileInput

SetUserId sets the UserId field's value.

func (UpdateUserRoutingProfileInput) String 

func (s UpdateUserRoutingProfileInput) String() string

String returns the string representation

func (*UpdateUserRoutingProfileInput) Validate 

func (s *UpdateUserRoutingProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateUserRoutingProfileOutput 

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

func (UpdateUserRoutingProfileOutput) GoString 

func (s UpdateUserRoutingProfileOutput) GoString() string

GoString returns the string representation

func (UpdateUserRoutingProfileOutput) String 

func (s UpdateUserRoutingProfileOutput) String() string

String returns the string representation

type UpdateUserSecurityProfilesInput 

type UpdateUserSecurityProfilesInput struct {

	// The identifier for your Amazon Connect instance. To find the ID of your instance,
	// open the AWS console and select Amazon Connect. Select the alias of the instance
	// in the Instance alias column. The instance ID is displayed in the Overview
	// section of your instance settings. For example, the instance ID is the set
	// of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`

	// The identifiers for the security profiles to assign to the user.
	//
	// SecurityProfileIds is a required field
	SecurityProfileIds []*string `min:"1" type:"list" required:"true"`

	// The identifier of the user account to assign the security profiles.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserSecurityProfilesInput) GoString 

func (s UpdateUserSecurityProfilesInput) GoString() string

GoString returns the string representation

func (*UpdateUserSecurityProfilesInput) SetInstanceId 

func (s *UpdateUserSecurityProfilesInput) SetInstanceId(v string) *UpdateUserSecurityProfilesInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateUserSecurityProfilesInput) SetSecurityProfileIds 

func (s *UpdateUserSecurityProfilesInput) SetSecurityProfileIds(v []*string) *UpdateUserSecurityProfilesInput

SetSecurityProfileIds sets the SecurityProfileIds field's value.

func (*UpdateUserSecurityProfilesInput) SetUserId 

func (s *UpdateUserSecurityProfilesInput) SetUserId(v string) *UpdateUserSecurityProfilesInput

SetUserId sets the UserId field's value.

func (UpdateUserSecurityProfilesInput) String 

func (s UpdateUserSecurityProfilesInput) String() string

String returns the string representation

func (*UpdateUserSecurityProfilesInput) Validate 

func (s *UpdateUserSecurityProfilesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateUserSecurityProfilesOutput 

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

func (UpdateUserSecurityProfilesOutput) GoString 

func (s UpdateUserSecurityProfilesOutput) GoString() string

GoString returns the string representation

func (UpdateUserSecurityProfilesOutput) String 

func (s UpdateUserSecurityProfilesOutput) String() string

String returns the string representation

type User 

type User struct {

	// The ARN of the user account.
	Arn *string `type:"string"`

	// The directory Id for the user account in the existing directory used for
	// identity management.
	DirectoryUserId *string `type:"string"`

	// The identifier for the hierarchy group assigned to the user.
	HierarchyGroupId *string `type:"string"`

	// The identifier of the user account.
	Id *string `type:"string"`

	// A UserIdentityInfo object.
	IdentityInfo *UserIdentityInfo `type:"structure"`

	// A UserPhoneConfig object.
	PhoneConfig *UserPhoneConfig `type:"structure"`

	// The identifier of the routing profile assigned to the user.
	RoutingProfileId *string `type:"string"`

	// The identifier(s) for the security profile assigned to the user.
	SecurityProfileIds []*string `min:"1" type:"list"`

	// The user name assigned to the user account.
	Username *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A User object that contains information about a user account in your Amazon Connect instance, including configuration settings.

func (User) GoString 

func (s User) GoString() string

GoString returns the string representation

func (*User) SetArn 

func (s *User) SetArn(v string) *User

SetArn sets the Arn field's value.

func (*User) SetDirectoryUserId 

func (s *User) SetDirectoryUserId(v string) *User

SetDirectoryUserId sets the DirectoryUserId field's value.

func (*User) SetHierarchyGroupId 

func (s *User) SetHierarchyGroupId(v string) *User

SetHierarchyGroupId sets the HierarchyGroupId field's value.

func (*User) SetId 

func (s *User) SetId(v string) *User

SetId sets the Id field's value.

func (*User) SetIdentityInfo 

func (s *User) SetIdentityInfo(v *UserIdentityInfo) *User

SetIdentityInfo sets the IdentityInfo field's value.

func (*User) SetPhoneConfig 

func (s *User) SetPhoneConfig(v *UserPhoneConfig) *User

SetPhoneConfig sets the PhoneConfig field's value.

func (*User) SetRoutingProfileId 

func (s *User) SetRoutingProfileId(v string) *User

SetRoutingProfileId sets the RoutingProfileId field's value.

func (*User) SetSecurityProfileIds 

func (s *User) SetSecurityProfileIds(v []*string) *User

SetSecurityProfileIds sets the SecurityProfileIds field's value.

func (*User) SetUsername 

func (s *User) SetUsername(v string) *User

SetUsername sets the Username field's value.

func (User) String 

func (s User) String() string

String returns the string representation

type UserIdentityInfo 

type UserIdentityInfo struct {

	// The email address added to the user account. If you are using SAML for identity
	// management and include this parameter, an InvalidRequestException is returned.
	Email *string `type:"string"`

	// The first name used in the user account. This is required if you are using
	// Amazon Connect or SAML for identity management.
	FirstName *string `min:"1" type:"string"`

	// The last name used in the user account. This is required if you are using
	// Amazon Connect or SAML for identity management.
	LastName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A UserIdentityInfo object that contains information about the user's identity, including email address, first name, and last name.

func (UserIdentityInfo) GoString 

func (s UserIdentityInfo) GoString() string

GoString returns the string representation

func (*UserIdentityInfo) SetEmail 

func (s *UserIdentityInfo) SetEmail(v string) *UserIdentityInfo

SetEmail sets the Email field's value.

func (*UserIdentityInfo) SetFirstName 

func (s *UserIdentityInfo) SetFirstName(v string) *UserIdentityInfo

SetFirstName sets the FirstName field's value.

func (*UserIdentityInfo) SetLastName 

func (s *UserIdentityInfo) SetLastName(v string) *UserIdentityInfo

SetLastName sets the LastName field's value.

func (UserIdentityInfo) String 

func (s UserIdentityInfo) String() string

String returns the string representation

func (*UserIdentityInfo) Validate 

func (s *UserIdentityInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UserPhoneConfig 

type UserPhoneConfig struct {

	// The After Call Work (ACW) timeout setting, in seconds, for the user.
	AfterContactWorkTimeLimit *int64 `type:"integer"`

	// The Auto accept setting for the user, Yes or No.
	AutoAccept *bool `type:"boolean"`

	// The phone number for the user's desk phone.
	DeskPhoneNumber *string `type:"string"`

	// The phone type selected for the user, either Soft phone or Desk phone.
	//
	// PhoneType is a required field
	PhoneType *string `type:"string" required:"true" enum:"PhoneType"`
	// contains filtered or unexported fields
}

A UserPhoneConfig object that contains information about the user phone configuration settings.

func (UserPhoneConfig) GoString 

func (s UserPhoneConfig) GoString() string

GoString returns the string representation

func (*UserPhoneConfig) SetAfterContactWorkTimeLimit 

func (s *UserPhoneConfig) SetAfterContactWorkTimeLimit(v int64) *UserPhoneConfig

SetAfterContactWorkTimeLimit sets the AfterContactWorkTimeLimit field's value.

func (*UserPhoneConfig) SetAutoAccept 

func (s *UserPhoneConfig) SetAutoAccept(v bool) *UserPhoneConfig

SetAutoAccept sets the AutoAccept field's value.

func (*UserPhoneConfig) SetDeskPhoneNumber 

func (s *UserPhoneConfig) SetDeskPhoneNumber(v string) *UserPhoneConfig

SetDeskPhoneNumber sets the DeskPhoneNumber field's value.

func (*UserPhoneConfig) SetPhoneType 

func (s *UserPhoneConfig) SetPhoneType(v string) *UserPhoneConfig

SetPhoneType sets the PhoneType field's value.

func (UserPhoneConfig) String 

func (s UserPhoneConfig) String() string

String returns the string representation

func (*UserPhoneConfig) Validate 

func (s *UserPhoneConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UserSummary 

type UserSummary struct {

	// The ARN for the user account.
	Arn *string `type:"string"`

	// The identifier for the user account.
	Id *string `type:"string"`

	// The Amazon Connect user name for the user account.
	Username *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A UserSummary object that contains Information about a user, including ARN, Id, and user name.

func (UserSummary) GoString 

func (s UserSummary) GoString() string

GoString returns the string representation

func (*UserSummary) SetArn 

func (s *UserSummary) SetArn(v string) *UserSummary

SetArn sets the Arn field's value.

func (*UserSummary) SetId 

func (s *UserSummary) SetId(v string) *UserSummary

SetId sets the Id field's value.

func (*UserSummary) SetUsername 

func (s *UserSummary) SetUsername(v string) *UserSummary

SetUsername sets the Username field's value.

func (UserSummary) String 

func (s UserSummary) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package connectiface provides an interface to enable mocking the Amazon Connect Service service client for testing your code.
 Package connectiface provides an interface to enable mocking the Amazon Connect Service service client for testing your code.

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.