connect

package
v0.13.0 Latest Latest
Warning

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

 Go to latest Published: Oct 2, 2019 License: Apache-2.0 Imports: 7 Imported by: 12

Documentation

Overview

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

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 use Amazon Connect 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 client 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 (
	ServiceName = "Amazon Connect" // Service's name
	ServiceID   = "Connect"        // Service's identifier
	EndpointsID = "connect"        // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Channel added in v0.5.0 

type Channel string
const (
	ChannelVoice Channel = "VOICE"
)

Enum values for Channel

func (Channel) MarshalValue added in v0.5.0 

func (enum Channel) MarshalValue() (string, error)

func (Channel) MarshalValueBuf added in v0.5.0 

func (enum Channel) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := connect.New(myConfig)

func (*Client) CreateUserRequest added in v0.9.0 

func (c *Client) CreateUserRequest(input *CreateUserInput) CreateUserRequest

CreateUserRequest returns a request value for making API operation for Amazon Connect Service.

Creates a new user account in your Amazon Connect instance. 

// Example sending a request using CreateUserRequest.
req := client.CreateUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteUserRequest added in v0.9.0 

func (c *Client) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest

DeleteUserRequest returns a request value for making API operation for Amazon Connect Service.

Deletes a user account from Amazon Connect. 

// Example sending a request using DeleteUserRequest.
req := client.DeleteUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeUserHierarchyGroupRequest added in v0.9.0 

func (c *Client) DescribeUserHierarchyGroupRequest(input *DescribeUserHierarchyGroupInput) DescribeUserHierarchyGroupRequest

DescribeUserHierarchyGroupRequest returns a request value for making API operation for Amazon Connect Service.

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

// Example sending a request using DescribeUserHierarchyGroupRequest.
req := client.DescribeUserHierarchyGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeUserHierarchyStructureRequest added in v0.9.0 

func (c *Client) DescribeUserHierarchyStructureRequest(input *DescribeUserHierarchyStructureInput) DescribeUserHierarchyStructureRequest

DescribeUserHierarchyStructureRequest returns a request value for making API operation for Amazon Connect Service.

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

// Example sending a request using DescribeUserHierarchyStructureRequest.
req := client.DescribeUserHierarchyStructureRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeUserRequest added in v0.9.0 

func (c *Client) DescribeUserRequest(input *DescribeUserInput) DescribeUserRequest

DescribeUserRequest returns a request value for making API operation for Amazon Connect Service.

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

// Example sending a request using DescribeUserRequest.
req := client.DescribeUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetContactAttributesRequest added in v0.9.0 

func (c *Client) GetContactAttributesRequest(input *GetContactAttributesInput) GetContactAttributesRequest

GetContactAttributesRequest returns a request value for making API operation for Amazon Connect Service.

Retrieves the contact attributes associated with a contact. 

// Example sending a request using GetContactAttributesRequest.
req := client.GetContactAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetCurrentMetricDataRequest added in v0.9.0 

func (c *Client) GetCurrentMetricDataRequest(input *GetCurrentMetricDataInput) GetCurrentMetricDataRequest

GetCurrentMetricDataRequest returns a request value for making 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. 

// Example sending a request using GetCurrentMetricDataRequest.
req := client.GetCurrentMetricDataRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetFederationTokenRequest added in v0.9.0 

func (c *Client) GetFederationTokenRequest(input *GetFederationTokenInput) GetFederationTokenRequest

GetFederationTokenRequest returns a request value for making API operation for Amazon Connect Service.

Retrieves a token for federation. 

// Example sending a request using GetFederationTokenRequest.
req := client.GetFederationTokenRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetMetricDataRequest added in v0.9.0 

func (c *Client) GetMetricDataRequest(input *GetMetricDataInput) GetMetricDataRequest

GetMetricDataRequest returns a request value for making 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. 

// Example sending a request using GetMetricDataRequest.
req := client.GetMetricDataRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListRoutingProfilesRequest added in v0.9.0 

func (c *Client) ListRoutingProfilesRequest(input *ListRoutingProfilesInput) ListRoutingProfilesRequest

ListRoutingProfilesRequest returns a request value for making API operation for Amazon Connect Service.

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

// Example sending a request using ListRoutingProfilesRequest.
req := client.ListRoutingProfilesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListSecurityProfilesRequest added in v0.9.0 

func (c *Client) ListSecurityProfilesRequest(input *ListSecurityProfilesInput) ListSecurityProfilesRequest

ListSecurityProfilesRequest returns a request value for making 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. 

// Example sending a request using ListSecurityProfilesRequest.
req := client.ListSecurityProfilesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListUserHierarchyGroupsRequest added in v0.9.0 

func (c *Client) ListUserHierarchyGroupsRequest(input *ListUserHierarchyGroupsInput) ListUserHierarchyGroupsRequest

ListUserHierarchyGroupsRequest returns a request value for making 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. 

// Example sending a request using ListUserHierarchyGroupsRequest.
req := client.ListUserHierarchyGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListUsersRequest added in v0.9.0 

func (c *Client) ListUsersRequest(input *ListUsersInput) ListUsersRequest

ListUsersRequest returns a request value for making API operation for Amazon Connect Service.

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

// Example sending a request using ListUsersRequest.
req := client.ListUsersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) StartOutboundVoiceContactRequest added in v0.9.0 

func (c *Client) StartOutboundVoiceContactRequest(input *StartOutboundVoiceContactInput) StartOutboundVoiceContactRequest

StartOutboundVoiceContactRequest returns a request value for making 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. 

// Example sending a request using StartOutboundVoiceContactRequest.
req := client.StartOutboundVoiceContactRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) StopContactRequest added in v0.9.0 

func (c *Client) StopContactRequest(input *StopContactInput) StopContactRequest

StopContactRequest returns a request value for making 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. 

// Example sending a request using StopContactRequest.
req := client.StopContactRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateContactAttributesRequest added in v0.9.0 

func (c *Client) UpdateContactAttributesRequest(input *UpdateContactAttributesInput) UpdateContactAttributesRequest

UpdateContactAttributesRequest returns a request value for making 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. 

// Example sending a request using UpdateContactAttributesRequest.
req := client.UpdateContactAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateUserHierarchyRequest added in v0.9.0 

func (c *Client) UpdateUserHierarchyRequest(input *UpdateUserHierarchyInput) UpdateUserHierarchyRequest

UpdateUserHierarchyRequest returns a request value for making API operation for Amazon Connect Service.

Assigns the specified hierarchy group to the user. 

// Example sending a request using UpdateUserHierarchyRequest.
req := client.UpdateUserHierarchyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateUserIdentityInfoRequest added in v0.9.0 

func (c *Client) UpdateUserIdentityInfoRequest(input *UpdateUserIdentityInfoInput) UpdateUserIdentityInfoRequest

UpdateUserIdentityInfoRequest returns a request value for making 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. 

// Example sending a request using UpdateUserIdentityInfoRequest.
req := client.UpdateUserIdentityInfoRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateUserPhoneConfigRequest added in v0.9.0 

func (c *Client) UpdateUserPhoneConfigRequest(input *UpdateUserPhoneConfigInput) UpdateUserPhoneConfigRequest

UpdateUserPhoneConfigRequest returns a request value for making API operation for Amazon Connect Service.

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

// Example sending a request using UpdateUserPhoneConfigRequest.
req := client.UpdateUserPhoneConfigRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateUserRoutingProfileRequest added in v0.9.0 

func (c *Client) UpdateUserRoutingProfileRequest(input *UpdateUserRoutingProfileInput) UpdateUserRoutingProfileRequest

UpdateUserRoutingProfileRequest returns a request value for making API operation for Amazon Connect Service.

Assigns the specified routing profile to a user. 

// Example sending a request using UpdateUserRoutingProfileRequest.
req := client.UpdateUserRoutingProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateUserSecurityProfilesRequest added in v0.9.0 

func (c *Client) UpdateUserSecurityProfilesRequest(input *UpdateUserSecurityProfilesInput) UpdateUserSecurityProfilesRequest

UpdateUserSecurityProfilesRequest returns a request value for making API operation for Amazon Connect Service.

Updates the security profiles assigned to the user. 

// Example sending a request using UpdateUserSecurityProfilesRequest.
req := client.UpdateUserSecurityProfilesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type Comparison added in v0.5.0 

type Comparison string
const (
	ComparisonLt Comparison = "LT"
)

Enum values for Comparison

func (Comparison) MarshalValue added in v0.5.0 

func (enum Comparison) MarshalValue() (string, error)

func (Comparison) MarshalValueBuf added in v0.5.0 

func (enum Comparison) MarshalValueBuf(b []byte) ([]byte, error)

type CreateUserInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s CreateUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateUserInput) String added in v0.5.0 

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate added in v0.5.0 

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s CreateUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateUserOutput) String added in v0.5.0 

func (s CreateUserOutput) String() string

String returns the string representation

type CreateUserRequest added in v0.5.0 

type CreateUserRequest struct {
	*aws.Request
	Input *CreateUserInput
	Copy  func(*CreateUserInput) CreateUserRequest
}

CreateUserRequest is the request type for the CreateUser API operation.

func (CreateUserRequest) Send added in v0.5.0 

func (r CreateUserRequest) Send(ctx context.Context) (*CreateUserResponse, error)

Send marshals and sends the CreateUser API request.

type CreateUserResponse added in v0.9.0 

type CreateUserResponse struct {
	*CreateUserOutput
	// contains filtered or unexported fields
}

CreateUserResponse is the response type for the CreateUser API operation.

func (*CreateUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateUser request.

type Credentials added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s Credentials) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Credentials) String added in v0.5.0 

func (s Credentials) String() string

String returns the string representation

type CurrentMetric added in v0.5.0 

type CurrentMetric struct {

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

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

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

func (CurrentMetric) MarshalFields added in v0.5.0 

func (s CurrentMetric) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CurrentMetric) String added in v0.5.0 

func (s CurrentMetric) String() string

String returns the string representation

type CurrentMetricData added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s CurrentMetricData) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CurrentMetricData) String added in v0.5.0 

func (s CurrentMetricData) String() string

String returns the string representation

type CurrentMetricName added in v0.5.0 

type CurrentMetricName string

A list of current metric names. 

const (
	CurrentMetricNameAgentsOnline           CurrentMetricName = "AGENTS_ONLINE"
	CurrentMetricNameAgentsAvailable        CurrentMetricName = "AGENTS_AVAILABLE"
	CurrentMetricNameAgentsOnCall           CurrentMetricName = "AGENTS_ON_CALL"
	CurrentMetricNameAgentsNonProductive    CurrentMetricName = "AGENTS_NON_PRODUCTIVE"
	CurrentMetricNameAgentsAfterContactWork CurrentMetricName = "AGENTS_AFTER_CONTACT_WORK"
	CurrentMetricNameAgentsError            CurrentMetricName = "AGENTS_ERROR"
	CurrentMetricNameAgentsStaffed          CurrentMetricName = "AGENTS_STAFFED"
	CurrentMetricNameContactsInQueue        CurrentMetricName = "CONTACTS_IN_QUEUE"
	CurrentMetricNameOldestContactAge       CurrentMetricName = "OLDEST_CONTACT_AGE"
	CurrentMetricNameContactsScheduled      CurrentMetricName = "CONTACTS_SCHEDULED"
)

Enum values for CurrentMetricName

func (CurrentMetricName) MarshalValue added in v0.5.0 

func (enum CurrentMetricName) MarshalValue() (string, error)

func (CurrentMetricName) MarshalValueBuf added in v0.5.0 

func (enum CurrentMetricName) MarshalValueBuf(b []byte) ([]byte, error)

type CurrentMetricResult added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s CurrentMetricResult) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CurrentMetricResult) String added in v0.5.0 

func (s CurrentMetricResult) String() string

String returns the string representation

type DeleteUserInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s DeleteUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteUserInput) String added in v0.5.0 

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate added in v0.5.0 

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput added in v0.5.0 

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

func (DeleteUserOutput) MarshalFields added in v0.5.0 

func (s DeleteUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteUserOutput) String added in v0.5.0 

func (s DeleteUserOutput) String() string

String returns the string representation

type DeleteUserRequest added in v0.5.0 

type DeleteUserRequest struct {
	*aws.Request
	Input *DeleteUserInput
	Copy  func(*DeleteUserInput) DeleteUserRequest
}

DeleteUserRequest is the request type for the DeleteUser API operation.

func (DeleteUserRequest) Send added in v0.5.0 

func (r DeleteUserRequest) Send(ctx context.Context) (*DeleteUserResponse, error)

Send marshals and sends the DeleteUser API request.

type DeleteUserResponse added in v0.9.0 

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

DeleteUserResponse is the response type for the DeleteUser API operation.

func (*DeleteUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteUser request.

type DescribeUserHierarchyGroupInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s DescribeUserHierarchyGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUserHierarchyGroupInput) String added in v0.5.0 

func (s DescribeUserHierarchyGroupInput) String() string

String returns the string representation

func (*DescribeUserHierarchyGroupInput) Validate added in v0.5.0 

func (s *DescribeUserHierarchyGroupInput) Validate() error

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

type DescribeUserHierarchyGroupOutput added in v0.5.0 

type DescribeUserHierarchyGroupOutput struct {

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

func (DescribeUserHierarchyGroupOutput) MarshalFields added in v0.5.0 

func (s DescribeUserHierarchyGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUserHierarchyGroupOutput) String added in v0.5.0 

func (s DescribeUserHierarchyGroupOutput) String() string

String returns the string representation

type DescribeUserHierarchyGroupRequest added in v0.5.0 

type DescribeUserHierarchyGroupRequest struct {
	*aws.Request
	Input *DescribeUserHierarchyGroupInput
	Copy  func(*DescribeUserHierarchyGroupInput) DescribeUserHierarchyGroupRequest
}

DescribeUserHierarchyGroupRequest is the request type for the DescribeUserHierarchyGroup API operation.

func (DescribeUserHierarchyGroupRequest) Send added in v0.5.0 

func (r DescribeUserHierarchyGroupRequest) Send(ctx context.Context) (*DescribeUserHierarchyGroupResponse, error)

Send marshals and sends the DescribeUserHierarchyGroup API request.

type DescribeUserHierarchyGroupResponse added in v0.9.0 

type DescribeUserHierarchyGroupResponse struct {
	*DescribeUserHierarchyGroupOutput
	// contains filtered or unexported fields
}

DescribeUserHierarchyGroupResponse is the response type for the DescribeUserHierarchyGroup API operation.

func (*DescribeUserHierarchyGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeUserHierarchyGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeUserHierarchyGroup request.

type DescribeUserHierarchyStructureInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s DescribeUserHierarchyStructureInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUserHierarchyStructureInput) String added in v0.5.0 

func (s DescribeUserHierarchyStructureInput) String() string

String returns the string representation

func (*DescribeUserHierarchyStructureInput) Validate added in v0.5.0 

func (s *DescribeUserHierarchyStructureInput) Validate() error

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

type DescribeUserHierarchyStructureOutput added in v0.5.0 

type DescribeUserHierarchyStructureOutput struct {

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

func (DescribeUserHierarchyStructureOutput) MarshalFields added in v0.5.0 

func (s DescribeUserHierarchyStructureOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUserHierarchyStructureOutput) String added in v0.5.0 

func (s DescribeUserHierarchyStructureOutput) String() string

String returns the string representation

type DescribeUserHierarchyStructureRequest added in v0.5.0 

type DescribeUserHierarchyStructureRequest struct {
	*aws.Request
	Input *DescribeUserHierarchyStructureInput
	Copy  func(*DescribeUserHierarchyStructureInput) DescribeUserHierarchyStructureRequest
}

DescribeUserHierarchyStructureRequest is the request type for the DescribeUserHierarchyStructure API operation.

func (DescribeUserHierarchyStructureRequest) Send added in v0.5.0 

func (r DescribeUserHierarchyStructureRequest) Send(ctx context.Context) (*DescribeUserHierarchyStructureResponse, error)

Send marshals and sends the DescribeUserHierarchyStructure API request.

type DescribeUserHierarchyStructureResponse added in v0.9.0 

type DescribeUserHierarchyStructureResponse struct {
	*DescribeUserHierarchyStructureOutput
	// contains filtered or unexported fields
}

DescribeUserHierarchyStructureResponse is the response type for the DescribeUserHierarchyStructure API operation.

func (*DescribeUserHierarchyStructureResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeUserHierarchyStructureResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeUserHierarchyStructure request.

type DescribeUserInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s DescribeUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUserInput) String added in v0.5.0 

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate added in v0.5.0 

func (s *DescribeUserInput) Validate() error

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

type DescribeUserOutput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s DescribeUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUserOutput) String added in v0.5.0 

func (s DescribeUserOutput) String() string

String returns the string representation

type DescribeUserRequest added in v0.5.0 

type DescribeUserRequest struct {
	*aws.Request
	Input *DescribeUserInput
	Copy  func(*DescribeUserInput) DescribeUserRequest
}

DescribeUserRequest is the request type for the DescribeUser API operation.

func (DescribeUserRequest) Send added in v0.5.0 

func (r DescribeUserRequest) Send(ctx context.Context) (*DescribeUserResponse, error)

Send marshals and sends the DescribeUser API request.

type DescribeUserResponse added in v0.9.0 

type DescribeUserResponse struct {
	*DescribeUserOutput
	// contains filtered or unexported fields
}

DescribeUserResponse is the response type for the DescribeUser API operation.

func (*DescribeUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeUser request.

type Dimensions added in v0.5.0 

type Dimensions struct {

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

	// 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) MarshalFields added in v0.5.0 

func (s Dimensions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Dimensions) String added in v0.5.0 

func (s Dimensions) String() string

String returns the string representation

type Filters added in v0.5.0 

type Filters struct {

	// The Channel to use as a filter for the metrics returned. Only VOICE is supported.
	Channels []Channel `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) MarshalFields added in v0.5.0 

func (s Filters) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Filters) String added in v0.5.0 

func (s Filters) String() string

String returns the string representation

func (*Filters) Validate added in v0.5.0 

func (s *Filters) Validate() error

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

type GetContactAttributesInput added in v0.7.0 

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) MarshalFields added in v0.7.0 

func (s GetContactAttributesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetContactAttributesInput) String added in v0.7.0 

func (s GetContactAttributesInput) String() string

String returns the string representation

func (*GetContactAttributesInput) Validate added in v0.7.0 

func (s *GetContactAttributesInput) Validate() error

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

type GetContactAttributesOutput added in v0.7.0 

type GetContactAttributesOutput struct {

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

func (GetContactAttributesOutput) MarshalFields added in v0.7.0 

func (s GetContactAttributesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetContactAttributesOutput) String added in v0.7.0 

func (s GetContactAttributesOutput) String() string

String returns the string representation

type GetContactAttributesRequest added in v0.7.0 

type GetContactAttributesRequest struct {
	*aws.Request
	Input *GetContactAttributesInput
	Copy  func(*GetContactAttributesInput) GetContactAttributesRequest
}

GetContactAttributesRequest is the request type for the GetContactAttributes API operation.

func (GetContactAttributesRequest) Send added in v0.7.0 

func (r GetContactAttributesRequest) Send(ctx context.Context) (*GetContactAttributesResponse, error)

Send marshals and sends the GetContactAttributes API request.

type GetContactAttributesResponse added in v0.9.0 

type GetContactAttributesResponse struct {
	*GetContactAttributesOutput
	// contains filtered or unexported fields
}

GetContactAttributesResponse is the response type for the GetContactAttributes API operation.

func (*GetContactAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetContactAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetContactAttributes request.

type GetCurrentMetricDataInput added in v0.5.0 

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_AVAILABLE
	//
	// Unit: COUNT
	//
	// AGENTS_ONLINE
	//
	// Unit: COUNT
	//
	// AGENTS_ON_CALL
	//
	// Unit: COUNT
	//
	// AGENTS_STAFFED
	//
	// Unit: COUNT
	//
	// AGENTS_AFTER_CONTACT_WORK
	//
	// Unit: COUNT
	//
	// AGENTS_NON_PRODUCTIVE
	//
	// Unit: COUNT
	//
	// AGENTS_ERROR
	//
	// Unit: COUNT
	//
	// CONTACTS_IN_QUEUE
	//
	// Unit: COUNT
	//
	// OLDEST_CONTACT_AGE
	//
	// Unit: SECONDS
	//
	// CONTACTS_SCHEDULED
	//
	// Unit: 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 []Grouping `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) MarshalFields added in v0.5.0 

func (s GetCurrentMetricDataInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetCurrentMetricDataInput) String added in v0.5.0 

func (s GetCurrentMetricDataInput) String() string

String returns the string representation

func (*GetCurrentMetricDataInput) Validate added in v0.5.0 

func (s *GetCurrentMetricDataInput) Validate() error

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

type GetCurrentMetricDataOutput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s GetCurrentMetricDataOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetCurrentMetricDataOutput) String added in v0.5.0 

func (s GetCurrentMetricDataOutput) String() string

String returns the string representation

type GetCurrentMetricDataPaginator added in v0.9.0 

type GetCurrentMetricDataPaginator struct {
	aws.Pager
}

GetCurrentMetricDataPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetCurrentMetricDataPaginator added in v0.9.0 

func NewGetCurrentMetricDataPaginator(req GetCurrentMetricDataRequest) GetCurrentMetricDataPaginator

NewGetCurrentMetricDataRequestPaginator returns a paginator for GetCurrentMetricData. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetCurrentMetricDataRequest(input)
p := connect.NewGetCurrentMetricDataRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetCurrentMetricDataPaginator) CurrentPage added in v0.9.0 

func (p *GetCurrentMetricDataPaginator) CurrentPage() *GetCurrentMetricDataOutput

type GetCurrentMetricDataRequest added in v0.5.0 

type GetCurrentMetricDataRequest struct {
	*aws.Request
	Input *GetCurrentMetricDataInput
	Copy  func(*GetCurrentMetricDataInput) GetCurrentMetricDataRequest
}

GetCurrentMetricDataRequest is the request type for the GetCurrentMetricData API operation.

func (GetCurrentMetricDataRequest) Send added in v0.5.0 

func (r GetCurrentMetricDataRequest) Send(ctx context.Context) (*GetCurrentMetricDataResponse, error)

Send marshals and sends the GetCurrentMetricData API request.

type GetCurrentMetricDataResponse added in v0.9.0 

type GetCurrentMetricDataResponse struct {
	*GetCurrentMetricDataOutput
	// contains filtered or unexported fields
}

GetCurrentMetricDataResponse is the response type for the GetCurrentMetricData API operation.

func (*GetCurrentMetricDataResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetCurrentMetricDataResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetCurrentMetricData request.

type GetFederationTokenInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s GetFederationTokenInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetFederationTokenInput) String added in v0.5.0 

func (s GetFederationTokenInput) String() string

String returns the string representation

func (*GetFederationTokenInput) Validate added in v0.5.0 

func (s *GetFederationTokenInput) Validate() error

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

type GetFederationTokenOutput added in v0.5.0 

type GetFederationTokenOutput struct {

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

func (GetFederationTokenOutput) MarshalFields added in v0.5.0 

func (s GetFederationTokenOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetFederationTokenOutput) String added in v0.5.0 

func (s GetFederationTokenOutput) String() string

String returns the string representation

type GetFederationTokenRequest added in v0.5.0 

type GetFederationTokenRequest struct {
	*aws.Request
	Input *GetFederationTokenInput
	Copy  func(*GetFederationTokenInput) GetFederationTokenRequest
}

GetFederationTokenRequest is the request type for the GetFederationToken API operation.

func (GetFederationTokenRequest) Send added in v0.5.0 

func (r GetFederationTokenRequest) Send(ctx context.Context) (*GetFederationTokenResponse, error)

Send marshals and sends the GetFederationToken API request.

type GetFederationTokenResponse added in v0.9.0 

type GetFederationTokenResponse struct {
	*GetFederationTokenOutput
	// contains filtered or unexported fields
}

GetFederationTokenResponse is the response type for the GetFederationToken API operation.

func (*GetFederationTokenResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetFederationTokenResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetFederationToken request.

type GetMetricDataInput added in v0.5.0 

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 []Grouping `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_QUEUED
	//
	// Unit: COUNT
	//
	// Statistic: SUM
	//
	// CONTACTS_HANDLED
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_ABANDONED
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_CONSULTED
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_AGENT_HUNG_UP_FIRST
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_HANDLED_INCOMING
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_HANDLED_OUTBOUND
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_HOLD_ABANDONS
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_TRANSFERRED_IN
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_TRANSFERRED_OUT
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_TRANSFERRED_IN_FROM_QUEUE
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CALLBACK_CONTACTS_HANDLED
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CALLBACK_CONTACTS_HANDLED
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// API_CONTACTS_HANDLED
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// CONTACTS_MISSED
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// OCCUPANCY
	//
	// Unit: PERCENT
	//
	// Statistics: AVG
	//
	// HANDLE_TIME
	//
	// Unit: SECONDS
	//
	// Statistics: AVG
	//
	// AFTER_CONTACT_WORK_TIME
	//
	// Unit: SECONDS
	//
	// Statistics: AVG
	//
	// QUEUED_TIME
	//
	// Unit: SECONDS
	//
	// Statistics: MAX
	//
	// ABANDON_TIME
	//
	// Unit: COUNT
	//
	// Statistics: SUM
	//
	// QUEUE_ANSWER_TIME
	//
	// Unit: SECONDS
	//
	// Statistics: AVG
	//
	// HOLD_TIME
	//
	// Unit: SECONDS
	//
	// Statistics: AVG
	//
	// INTERACTION_TIME
	//
	// Unit: SECONDS
	//
	// Statistics: AVG
	//
	// INTERACTION_AND_HOLD_TIME
	//
	// Unit: SECONDS
	//
	// Statistics: AVG
	//
	// SERVICE_LEVEL
	//
	// Unit: 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) MarshalFields added in v0.5.0 

func (s GetMetricDataInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetMetricDataInput) String added in v0.5.0 

func (s GetMetricDataInput) String() string

String returns the string representation

func (*GetMetricDataInput) Validate added in v0.5.0 

func (s *GetMetricDataInput) Validate() error

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

type GetMetricDataOutput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s GetMetricDataOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetMetricDataOutput) String added in v0.5.0 

func (s GetMetricDataOutput) String() string

String returns the string representation

type GetMetricDataPaginator added in v0.9.0 

type GetMetricDataPaginator struct {
	aws.Pager
}

GetMetricDataPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetMetricDataPaginator added in v0.9.0 

func NewGetMetricDataPaginator(req GetMetricDataRequest) GetMetricDataPaginator

NewGetMetricDataRequestPaginator returns a paginator for GetMetricData. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetMetricDataRequest(input)
p := connect.NewGetMetricDataRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetMetricDataPaginator) CurrentPage added in v0.9.0 

func (p *GetMetricDataPaginator) CurrentPage() *GetMetricDataOutput

type GetMetricDataRequest added in v0.5.0 

type GetMetricDataRequest struct {
	*aws.Request
	Input *GetMetricDataInput
	Copy  func(*GetMetricDataInput) GetMetricDataRequest
}

GetMetricDataRequest is the request type for the GetMetricData API operation.

func (GetMetricDataRequest) Send added in v0.5.0 

func (r GetMetricDataRequest) Send(ctx context.Context) (*GetMetricDataResponse, error)

Send marshals and sends the GetMetricData API request.

type GetMetricDataResponse added in v0.9.0 

type GetMetricDataResponse struct {
	*GetMetricDataOutput
	// contains filtered or unexported fields
}

GetMetricDataResponse is the response type for the GetMetricData API operation.

func (*GetMetricDataResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetMetricDataResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetMetricData request.

type Grouping added in v0.5.0 

type Grouping string
const (
	GroupingQueue   Grouping = "QUEUE"
	GroupingChannel Grouping = "CHANNEL"
)

Enum values for Grouping

func (Grouping) MarshalValue added in v0.5.0 

func (enum Grouping) MarshalValue() (string, error)

func (Grouping) MarshalValueBuf added in v0.5.0 

func (enum Grouping) MarshalValueBuf(b []byte) ([]byte, error)

type HierarchyGroup added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s HierarchyGroup) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HierarchyGroup) String added in v0.5.0 

func (s HierarchyGroup) String() string

String returns the string representation

type HierarchyGroupSummary added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s HierarchyGroupSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HierarchyGroupSummary) String added in v0.5.0 

func (s HierarchyGroupSummary) String() string

String returns the string representation

type HierarchyLevel added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s HierarchyLevel) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HierarchyLevel) String added in v0.5.0 

func (s HierarchyLevel) String() string

String returns the string representation

type HierarchyPath added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s HierarchyPath) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HierarchyPath) String added in v0.5.0 

func (s HierarchyPath) String() string

String returns the string representation

type HierarchyStructure added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s HierarchyStructure) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HierarchyStructure) String added in v0.5.0 

func (s HierarchyStructure) String() string

String returns the string representation

type HistoricalMetric added in v0.5.0 

type HistoricalMetric struct {

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

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

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

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

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

func (HistoricalMetric) MarshalFields added in v0.5.0 

func (s HistoricalMetric) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HistoricalMetric) String added in v0.5.0 

func (s HistoricalMetric) String() string

String returns the string representation

type HistoricalMetricData added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s HistoricalMetricData) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HistoricalMetricData) String added in v0.5.0 

func (s HistoricalMetricData) String() string

String returns the string representation

type HistoricalMetricName added in v0.5.0 

type HistoricalMetricName string

A list of historical metric names. 

const (
	HistoricalMetricNameContactsQueued                  HistoricalMetricName = "CONTACTS_QUEUED"
	HistoricalMetricNameContactsHandled                 HistoricalMetricName = "CONTACTS_HANDLED"
	HistoricalMetricNameContactsAbandoned               HistoricalMetricName = "CONTACTS_ABANDONED"
	HistoricalMetricNameContactsConsulted               HistoricalMetricName = "CONTACTS_CONSULTED"
	HistoricalMetricNameContactsAgentHungUpFirst        HistoricalMetricName = "CONTACTS_AGENT_HUNG_UP_FIRST"
	HistoricalMetricNameContactsHandledIncoming         HistoricalMetricName = "CONTACTS_HANDLED_INCOMING"
	HistoricalMetricNameContactsHandledOutbound         HistoricalMetricName = "CONTACTS_HANDLED_OUTBOUND"
	HistoricalMetricNameContactsHoldAbandons            HistoricalMetricName = "CONTACTS_HOLD_ABANDONS"
	HistoricalMetricNameContactsTransferredIn           HistoricalMetricName = "CONTACTS_TRANSFERRED_IN"
	HistoricalMetricNameContactsTransferredOut          HistoricalMetricName = "CONTACTS_TRANSFERRED_OUT"
	HistoricalMetricNameContactsTransferredInFromQueue  HistoricalMetricName = "CONTACTS_TRANSFERRED_IN_FROM_QUEUE"
	HistoricalMetricNameContactsTransferredOutFromQueue HistoricalMetricName = "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE"
	HistoricalMetricNameContactsMissed                  HistoricalMetricName = "CONTACTS_MISSED"
	HistoricalMetricNameCallbackContactsHandled         HistoricalMetricName = "CALLBACK_CONTACTS_HANDLED"
	HistoricalMetricNameApiContactsHandled              HistoricalMetricName = "API_CONTACTS_HANDLED"
	HistoricalMetricNameOccupancy                       HistoricalMetricName = "OCCUPANCY"
	HistoricalMetricNameHandleTime                      HistoricalMetricName = "HANDLE_TIME"
	HistoricalMetricNameAfterContactWorkTime            HistoricalMetricName = "AFTER_CONTACT_WORK_TIME"
	HistoricalMetricNameQueuedTime                      HistoricalMetricName = "QUEUED_TIME"
	HistoricalMetricNameAbandonTime                     HistoricalMetricName = "ABANDON_TIME"
	HistoricalMetricNameQueueAnswerTime                 HistoricalMetricName = "QUEUE_ANSWER_TIME"
	HistoricalMetricNameHoldTime                        HistoricalMetricName = "HOLD_TIME"
	HistoricalMetricNameInteractionTime                 HistoricalMetricName = "INTERACTION_TIME"
	HistoricalMetricNameInteractionAndHoldTime          HistoricalMetricName = "INTERACTION_AND_HOLD_TIME"
	HistoricalMetricNameServiceLevel                    HistoricalMetricName = "SERVICE_LEVEL"
)

Enum values for HistoricalMetricName

func (HistoricalMetricName) MarshalValue added in v0.5.0 

func (enum HistoricalMetricName) MarshalValue() (string, error)

func (HistoricalMetricName) MarshalValueBuf added in v0.5.0 

func (enum HistoricalMetricName) MarshalValueBuf(b []byte) ([]byte, error)

type HistoricalMetricResult added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s HistoricalMetricResult) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HistoricalMetricResult) String added in v0.5.0 

func (s HistoricalMetricResult) String() string

String returns the string representation

type ListRoutingProfilesInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s ListRoutingProfilesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListRoutingProfilesInput) String added in v0.5.0 

func (s ListRoutingProfilesInput) String() string

String returns the string representation

func (*ListRoutingProfilesInput) Validate added in v0.5.0 

func (s *ListRoutingProfilesInput) Validate() error

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

type ListRoutingProfilesOutput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s ListRoutingProfilesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListRoutingProfilesOutput) String added in v0.5.0 

func (s ListRoutingProfilesOutput) String() string

String returns the string representation

type ListRoutingProfilesRequest added in v0.5.0 

type ListRoutingProfilesRequest struct {
	*aws.Request
	Input *ListRoutingProfilesInput
	Copy  func(*ListRoutingProfilesInput) ListRoutingProfilesRequest
}

ListRoutingProfilesRequest is the request type for the ListRoutingProfiles API operation.

func (ListRoutingProfilesRequest) Send added in v0.5.0 

func (r ListRoutingProfilesRequest) Send(ctx context.Context) (*ListRoutingProfilesResponse, error)

Send marshals and sends the ListRoutingProfiles API request.

type ListRoutingProfilesResponse added in v0.9.0 

type ListRoutingProfilesResponse struct {
	*ListRoutingProfilesOutput
	// contains filtered or unexported fields
}

ListRoutingProfilesResponse is the response type for the ListRoutingProfiles API operation.

func (*ListRoutingProfilesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListRoutingProfilesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListRoutingProfiles request.

type ListSecurityProfilesInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s ListSecurityProfilesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListSecurityProfilesInput) String added in v0.5.0 

func (s ListSecurityProfilesInput) String() string

String returns the string representation

func (*ListSecurityProfilesInput) Validate added in v0.5.0 

func (s *ListSecurityProfilesInput) Validate() error

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

type ListSecurityProfilesOutput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s ListSecurityProfilesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListSecurityProfilesOutput) String added in v0.5.0 

func (s ListSecurityProfilesOutput) String() string

String returns the string representation

type ListSecurityProfilesRequest added in v0.5.0 

type ListSecurityProfilesRequest struct {
	*aws.Request
	Input *ListSecurityProfilesInput
	Copy  func(*ListSecurityProfilesInput) ListSecurityProfilesRequest
}

ListSecurityProfilesRequest is the request type for the ListSecurityProfiles API operation.

func (ListSecurityProfilesRequest) Send added in v0.5.0 

func (r ListSecurityProfilesRequest) Send(ctx context.Context) (*ListSecurityProfilesResponse, error)

Send marshals and sends the ListSecurityProfiles API request.

type ListSecurityProfilesResponse added in v0.9.0 

type ListSecurityProfilesResponse struct {
	*ListSecurityProfilesOutput
	// contains filtered or unexported fields
}

ListSecurityProfilesResponse is the response type for the ListSecurityProfiles API operation.

func (*ListSecurityProfilesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListSecurityProfilesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListSecurityProfiles request.

type ListUserHierarchyGroupsInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s ListUserHierarchyGroupsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListUserHierarchyGroupsInput) String added in v0.5.0 

func (s ListUserHierarchyGroupsInput) String() string

String returns the string representation

func (*ListUserHierarchyGroupsInput) Validate added in v0.5.0 

func (s *ListUserHierarchyGroupsInput) Validate() error

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

type ListUserHierarchyGroupsOutput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s ListUserHierarchyGroupsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListUserHierarchyGroupsOutput) String added in v0.5.0 

func (s ListUserHierarchyGroupsOutput) String() string

String returns the string representation

type ListUserHierarchyGroupsRequest added in v0.5.0 

type ListUserHierarchyGroupsRequest struct {
	*aws.Request
	Input *ListUserHierarchyGroupsInput
	Copy  func(*ListUserHierarchyGroupsInput) ListUserHierarchyGroupsRequest
}

ListUserHierarchyGroupsRequest is the request type for the ListUserHierarchyGroups API operation.

func (ListUserHierarchyGroupsRequest) Send added in v0.5.0 

func (r ListUserHierarchyGroupsRequest) Send(ctx context.Context) (*ListUserHierarchyGroupsResponse, error)

Send marshals and sends the ListUserHierarchyGroups API request.

type ListUserHierarchyGroupsResponse added in v0.9.0 

type ListUserHierarchyGroupsResponse struct {
	*ListUserHierarchyGroupsOutput
	// contains filtered or unexported fields
}

ListUserHierarchyGroupsResponse is the response type for the ListUserHierarchyGroups API operation.

func (*ListUserHierarchyGroupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListUserHierarchyGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListUserHierarchyGroups request.

type ListUsersInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s ListUsersInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListUsersInput) String added in v0.5.0 

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate added in v0.5.0 

func (s *ListUsersInput) Validate() error

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

type ListUsersOutput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s ListUsersOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListUsersOutput) String added in v0.5.0 

func (s ListUsersOutput) String() string

String returns the string representation

type ListUsersRequest added in v0.5.0 

type ListUsersRequest struct {
	*aws.Request
	Input *ListUsersInput
	Copy  func(*ListUsersInput) ListUsersRequest
}

ListUsersRequest is the request type for the ListUsers API operation.

func (ListUsersRequest) Send added in v0.5.0 

func (r ListUsersRequest) Send(ctx context.Context) (*ListUsersResponse, error)

Send marshals and sends the ListUsers API request.

type ListUsersResponse added in v0.9.0 

type ListUsersResponse struct {
	*ListUsersOutput
	// contains filtered or unexported fields
}

ListUsersResponse is the response type for the ListUsers API operation.

func (*ListUsersResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListUsersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListUsers request.

type PhoneType added in v0.5.0 

type PhoneType string
const (
	PhoneTypeSoftPhone PhoneType = "SOFT_PHONE"
	PhoneTypeDeskPhone PhoneType = "DESK_PHONE"
)

Enum values for PhoneType

func (PhoneType) MarshalValue added in v0.5.0 

func (enum PhoneType) MarshalValue() (string, error)

func (PhoneType) MarshalValueBuf added in v0.5.0 

func (enum PhoneType) MarshalValueBuf(b []byte) ([]byte, error)

type QueueReference added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s QueueReference) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (QueueReference) String added in v0.5.0 

func (s QueueReference) String() string

String returns the string representation

type RoutingProfileSummary added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s RoutingProfileSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RoutingProfileSummary) String added in v0.5.0 

func (s RoutingProfileSummary) String() string

String returns the string representation

type SecurityProfileSummary added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s SecurityProfileSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SecurityProfileSummary) String added in v0.5.0 

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

func (s StartOutboundVoiceContactInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s StartOutboundVoiceContactOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartOutboundVoiceContactOutput) String 

func (s StartOutboundVoiceContactOutput) String() string

String returns the string representation

type StartOutboundVoiceContactRequest 

type StartOutboundVoiceContactRequest struct {
	*aws.Request
	Input *StartOutboundVoiceContactInput
	Copy  func(*StartOutboundVoiceContactInput) StartOutboundVoiceContactRequest
}

StartOutboundVoiceContactRequest is the request type for the StartOutboundVoiceContact API operation.

func (StartOutboundVoiceContactRequest) Send 

func (r StartOutboundVoiceContactRequest) Send(ctx context.Context) (*StartOutboundVoiceContactResponse, error)

Send marshals and sends the StartOutboundVoiceContact API request.

type StartOutboundVoiceContactResponse added in v0.9.0 

type StartOutboundVoiceContactResponse struct {
	*StartOutboundVoiceContactOutput
	// contains filtered or unexported fields
}

StartOutboundVoiceContactResponse is the response type for the StartOutboundVoiceContact API operation.

func (*StartOutboundVoiceContactResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartOutboundVoiceContactResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartOutboundVoiceContact request.

type Statistic added in v0.5.0 

type Statistic string
const (
	StatisticSum Statistic = "SUM"
	StatisticMax Statistic = "MAX"
	StatisticAvg Statistic = "AVG"
)

Enum values for Statistic

func (Statistic) MarshalValue added in v0.5.0 

func (enum Statistic) MarshalValue() (string, error)

func (Statistic) MarshalValueBuf added in v0.5.0 

func (enum Statistic) MarshalValueBuf(b []byte) ([]byte, error)

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

func (s StopContactInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s StopContactOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StopContactOutput) String 

func (s StopContactOutput) String() string

String returns the string representation

type StopContactRequest 

type StopContactRequest struct {
	*aws.Request
	Input *StopContactInput
	Copy  func(*StopContactInput) StopContactRequest
}

StopContactRequest is the request type for the StopContact API operation.

func (StopContactRequest) Send 

func (r StopContactRequest) Send(ctx context.Context) (*StopContactResponse, error)

Send marshals and sends the StopContact API request.

type StopContactResponse added in v0.9.0 

type StopContactResponse struct {
	*StopContactOutput
	// contains filtered or unexported fields
}

StopContactResponse is the response type for the StopContact API operation.

func (*StopContactResponse) SDKResponseMetdata added in v0.9.0 

func (r *StopContactResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopContact request.

type Threshold added in v0.5.0 

type Threshold struct {

	// The Threshold to use to compare service level metrics to. Only "Less than"
	// (LT) comparisons are supported.
	Comparison Comparison `type:"string" enum:"true"`

	// 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) MarshalFields added in v0.5.0 

func (s Threshold) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Threshold) String added in v0.5.0 

func (s Threshold) String() string

String returns the string representation

type Unit added in v0.5.0 

type Unit string
const (
	UnitSeconds Unit = "SECONDS"
	UnitCount   Unit = "COUNT"
	UnitPercent Unit = "PERCENT"
)

Enum values for Unit

func (Unit) MarshalValue added in v0.5.0 

func (enum Unit) MarshalValue() (string, error)

func (Unit) MarshalValueBuf added in v0.5.0 

func (enum Unit) MarshalValueBuf(b []byte) ([]byte, error)

type UpdateContactAttributesInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s UpdateContactAttributesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateContactAttributesInput) String added in v0.5.0 

func (s UpdateContactAttributesInput) String() string

String returns the string representation

func (*UpdateContactAttributesInput) Validate added in v0.5.0 

func (s *UpdateContactAttributesInput) Validate() error

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

type UpdateContactAttributesOutput added in v0.5.0 

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

func (UpdateContactAttributesOutput) MarshalFields added in v0.5.0 

func (s UpdateContactAttributesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateContactAttributesOutput) String added in v0.5.0 

func (s UpdateContactAttributesOutput) String() string

String returns the string representation

type UpdateContactAttributesRequest added in v0.5.0 

type UpdateContactAttributesRequest struct {
	*aws.Request
	Input *UpdateContactAttributesInput
	Copy  func(*UpdateContactAttributesInput) UpdateContactAttributesRequest
}

UpdateContactAttributesRequest is the request type for the UpdateContactAttributes API operation.

func (UpdateContactAttributesRequest) Send added in v0.5.0 

func (r UpdateContactAttributesRequest) Send(ctx context.Context) (*UpdateContactAttributesResponse, error)

Send marshals and sends the UpdateContactAttributes API request.

type UpdateContactAttributesResponse added in v0.9.0 

type UpdateContactAttributesResponse struct {
	*UpdateContactAttributesOutput
	// contains filtered or unexported fields
}

UpdateContactAttributesResponse is the response type for the UpdateContactAttributes API operation.

func (*UpdateContactAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateContactAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateContactAttributes request.

type UpdateUserHierarchyInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s UpdateUserHierarchyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserHierarchyInput) String added in v0.5.0 

func (s UpdateUserHierarchyInput) String() string

String returns the string representation

func (*UpdateUserHierarchyInput) Validate added in v0.5.0 

func (s *UpdateUserHierarchyInput) Validate() error

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

type UpdateUserHierarchyOutput added in v0.5.0 

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

func (UpdateUserHierarchyOutput) MarshalFields added in v0.5.0 

func (s UpdateUserHierarchyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserHierarchyOutput) String added in v0.5.0 

func (s UpdateUserHierarchyOutput) String() string

String returns the string representation

type UpdateUserHierarchyRequest added in v0.5.0 

type UpdateUserHierarchyRequest struct {
	*aws.Request
	Input *UpdateUserHierarchyInput
	Copy  func(*UpdateUserHierarchyInput) UpdateUserHierarchyRequest
}

UpdateUserHierarchyRequest is the request type for the UpdateUserHierarchy API operation.

func (UpdateUserHierarchyRequest) Send added in v0.5.0 

func (r UpdateUserHierarchyRequest) Send(ctx context.Context) (*UpdateUserHierarchyResponse, error)

Send marshals and sends the UpdateUserHierarchy API request.

type UpdateUserHierarchyResponse added in v0.9.0 

type UpdateUserHierarchyResponse struct {
	*UpdateUserHierarchyOutput
	// contains filtered or unexported fields
}

UpdateUserHierarchyResponse is the response type for the UpdateUserHierarchy API operation.

func (*UpdateUserHierarchyResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateUserHierarchyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateUserHierarchy request.

type UpdateUserIdentityInfoInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s UpdateUserIdentityInfoInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserIdentityInfoInput) String added in v0.5.0 

func (s UpdateUserIdentityInfoInput) String() string

String returns the string representation

func (*UpdateUserIdentityInfoInput) Validate added in v0.5.0 

func (s *UpdateUserIdentityInfoInput) Validate() error

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

type UpdateUserIdentityInfoOutput added in v0.5.0 

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

func (UpdateUserIdentityInfoOutput) MarshalFields added in v0.5.0 

func (s UpdateUserIdentityInfoOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserIdentityInfoOutput) String added in v0.5.0 

func (s UpdateUserIdentityInfoOutput) String() string

String returns the string representation

type UpdateUserIdentityInfoRequest added in v0.5.0 

type UpdateUserIdentityInfoRequest struct {
	*aws.Request
	Input *UpdateUserIdentityInfoInput
	Copy  func(*UpdateUserIdentityInfoInput) UpdateUserIdentityInfoRequest
}

UpdateUserIdentityInfoRequest is the request type for the UpdateUserIdentityInfo API operation.

func (UpdateUserIdentityInfoRequest) Send added in v0.5.0 

func (r UpdateUserIdentityInfoRequest) Send(ctx context.Context) (*UpdateUserIdentityInfoResponse, error)

Send marshals and sends the UpdateUserIdentityInfo API request.

type UpdateUserIdentityInfoResponse added in v0.9.0 

type UpdateUserIdentityInfoResponse struct {
	*UpdateUserIdentityInfoOutput
	// contains filtered or unexported fields
}

UpdateUserIdentityInfoResponse is the response type for the UpdateUserIdentityInfo API operation.

func (*UpdateUserIdentityInfoResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateUserIdentityInfoResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateUserIdentityInfo request.

type UpdateUserPhoneConfigInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s UpdateUserPhoneConfigInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserPhoneConfigInput) String added in v0.5.0 

func (s UpdateUserPhoneConfigInput) String() string

String returns the string representation

func (*UpdateUserPhoneConfigInput) Validate added in v0.5.0 

func (s *UpdateUserPhoneConfigInput) Validate() error

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

type UpdateUserPhoneConfigOutput added in v0.5.0 

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

func (UpdateUserPhoneConfigOutput) MarshalFields added in v0.5.0 

func (s UpdateUserPhoneConfigOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserPhoneConfigOutput) String added in v0.5.0 

func (s UpdateUserPhoneConfigOutput) String() string

String returns the string representation

type UpdateUserPhoneConfigRequest added in v0.5.0 

type UpdateUserPhoneConfigRequest struct {
	*aws.Request
	Input *UpdateUserPhoneConfigInput
	Copy  func(*UpdateUserPhoneConfigInput) UpdateUserPhoneConfigRequest
}

UpdateUserPhoneConfigRequest is the request type for the UpdateUserPhoneConfig API operation.

func (UpdateUserPhoneConfigRequest) Send added in v0.5.0 

func (r UpdateUserPhoneConfigRequest) Send(ctx context.Context) (*UpdateUserPhoneConfigResponse, error)

Send marshals and sends the UpdateUserPhoneConfig API request.

type UpdateUserPhoneConfigResponse added in v0.9.0 

type UpdateUserPhoneConfigResponse struct {
	*UpdateUserPhoneConfigOutput
	// contains filtered or unexported fields
}

UpdateUserPhoneConfigResponse is the response type for the UpdateUserPhoneConfig API operation.

func (*UpdateUserPhoneConfigResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateUserPhoneConfigResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateUserPhoneConfig request.

type UpdateUserRoutingProfileInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s UpdateUserRoutingProfileInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserRoutingProfileInput) String added in v0.5.0 

func (s UpdateUserRoutingProfileInput) String() string

String returns the string representation

func (*UpdateUserRoutingProfileInput) Validate added in v0.5.0 

func (s *UpdateUserRoutingProfileInput) Validate() error

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

type UpdateUserRoutingProfileOutput added in v0.5.0 

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

func (UpdateUserRoutingProfileOutput) MarshalFields added in v0.5.0 

func (s UpdateUserRoutingProfileOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserRoutingProfileOutput) String added in v0.5.0 

func (s UpdateUserRoutingProfileOutput) String() string

String returns the string representation

type UpdateUserRoutingProfileRequest added in v0.5.0 

type UpdateUserRoutingProfileRequest struct {
	*aws.Request
	Input *UpdateUserRoutingProfileInput
	Copy  func(*UpdateUserRoutingProfileInput) UpdateUserRoutingProfileRequest
}

UpdateUserRoutingProfileRequest is the request type for the UpdateUserRoutingProfile API operation.

func (UpdateUserRoutingProfileRequest) Send added in v0.5.0 

func (r UpdateUserRoutingProfileRequest) Send(ctx context.Context) (*UpdateUserRoutingProfileResponse, error)

Send marshals and sends the UpdateUserRoutingProfile API request.

type UpdateUserRoutingProfileResponse added in v0.9.0 

type UpdateUserRoutingProfileResponse struct {
	*UpdateUserRoutingProfileOutput
	// contains filtered or unexported fields
}

UpdateUserRoutingProfileResponse is the response type for the UpdateUserRoutingProfile API operation.

func (*UpdateUserRoutingProfileResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateUserRoutingProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateUserRoutingProfile request.

type UpdateUserSecurityProfilesInput added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s UpdateUserSecurityProfilesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserSecurityProfilesInput) String added in v0.5.0 

func (s UpdateUserSecurityProfilesInput) String() string

String returns the string representation

func (*UpdateUserSecurityProfilesInput) Validate added in v0.5.0 

func (s *UpdateUserSecurityProfilesInput) Validate() error

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

type UpdateUserSecurityProfilesOutput added in v0.5.0 

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

func (UpdateUserSecurityProfilesOutput) MarshalFields added in v0.5.0 

func (s UpdateUserSecurityProfilesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserSecurityProfilesOutput) String added in v0.5.0 

func (s UpdateUserSecurityProfilesOutput) String() string

String returns the string representation

type UpdateUserSecurityProfilesRequest added in v0.5.0 

type UpdateUserSecurityProfilesRequest struct {
	*aws.Request
	Input *UpdateUserSecurityProfilesInput
	Copy  func(*UpdateUserSecurityProfilesInput) UpdateUserSecurityProfilesRequest
}

UpdateUserSecurityProfilesRequest is the request type for the UpdateUserSecurityProfiles API operation.

func (UpdateUserSecurityProfilesRequest) Send added in v0.5.0 

func (r UpdateUserSecurityProfilesRequest) Send(ctx context.Context) (*UpdateUserSecurityProfilesResponse, error)

Send marshals and sends the UpdateUserSecurityProfiles API request.

type UpdateUserSecurityProfilesResponse added in v0.9.0 

type UpdateUserSecurityProfilesResponse struct {
	*UpdateUserSecurityProfilesOutput
	// contains filtered or unexported fields
}

UpdateUserSecurityProfilesResponse is the response type for the UpdateUserSecurityProfiles API operation.

func (*UpdateUserSecurityProfilesResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateUserSecurityProfilesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateUserSecurityProfiles request.

type User added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s User) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (User) String added in v0.5.0 

func (s User) String() string

String returns the string representation

type UserIdentityInfo added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s UserIdentityInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UserIdentityInfo) String added in v0.5.0 

func (s UserIdentityInfo) String() string

String returns the string representation

func (*UserIdentityInfo) Validate added in v0.5.0 

func (s *UserIdentityInfo) Validate() error

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

type UserPhoneConfig added in v0.5.0 

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 PhoneType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

A UserPhoneConfig object that contains information about the user phone configuration settings.

func (UserPhoneConfig) MarshalFields added in v0.5.0 

func (s UserPhoneConfig) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UserPhoneConfig) String added in v0.5.0 

func (s UserPhoneConfig) String() string

String returns the string representation

func (*UserPhoneConfig) Validate added in v0.5.0 

func (s *UserPhoneConfig) Validate() error

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

type UserSummary added in v0.5.0 

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) MarshalFields added in v0.5.0 

func (s UserSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UserSummary) String added in v0.5.0 

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.