Documentation ¶
Overview ¶
Package connect provides the client and types for making API requests to Amazon Connect.
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.
Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.
There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Limits (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the Amazon Connect Administrator Guide.
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
- type Channel
- type ChatMessage
- type Client
- func (c *Client) CreateUserRequest(input *CreateUserInput) CreateUserRequest
- func (c *Client) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest
- func (c *Client) DescribeUserHierarchyGroupRequest(input *DescribeUserHierarchyGroupInput) DescribeUserHierarchyGroupRequest
- func (c *Client) DescribeUserHierarchyStructureRequest(input *DescribeUserHierarchyStructureInput) DescribeUserHierarchyStructureRequest
- func (c *Client) DescribeUserRequest(input *DescribeUserInput) DescribeUserRequest
- func (c *Client) GetContactAttributesRequest(input *GetContactAttributesInput) GetContactAttributesRequest
- func (c *Client) GetCurrentMetricDataRequest(input *GetCurrentMetricDataInput) GetCurrentMetricDataRequest
- func (c *Client) GetFederationTokenRequest(input *GetFederationTokenInput) GetFederationTokenRequest
- func (c *Client) GetMetricDataRequest(input *GetMetricDataInput) GetMetricDataRequest
- func (c *Client) ListContactFlowsRequest(input *ListContactFlowsInput) ListContactFlowsRequest
- func (c *Client) ListHoursOfOperationsRequest(input *ListHoursOfOperationsInput) ListHoursOfOperationsRequest
- func (c *Client) ListPhoneNumbersRequest(input *ListPhoneNumbersInput) ListPhoneNumbersRequest
- func (c *Client) ListQueuesRequest(input *ListQueuesInput) ListQueuesRequest
- func (c *Client) ListRoutingProfilesRequest(input *ListRoutingProfilesInput) ListRoutingProfilesRequest
- func (c *Client) ListSecurityProfilesRequest(input *ListSecurityProfilesInput) ListSecurityProfilesRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) ListUserHierarchyGroupsRequest(input *ListUserHierarchyGroupsInput) ListUserHierarchyGroupsRequest
- func (c *Client) ListUsersRequest(input *ListUsersInput) ListUsersRequest
- func (c *Client) StartChatContactRequest(input *StartChatContactInput) StartChatContactRequest
- func (c *Client) StartOutboundVoiceContactRequest(input *StartOutboundVoiceContactInput) StartOutboundVoiceContactRequest
- func (c *Client) StopContactRequest(input *StopContactInput) StopContactRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdateContactAttributesRequest(input *UpdateContactAttributesInput) UpdateContactAttributesRequest
- func (c *Client) UpdateUserHierarchyRequest(input *UpdateUserHierarchyInput) UpdateUserHierarchyRequest
- func (c *Client) UpdateUserIdentityInfoRequest(input *UpdateUserIdentityInfoInput) UpdateUserIdentityInfoRequest
- func (c *Client) UpdateUserPhoneConfigRequest(input *UpdateUserPhoneConfigInput) UpdateUserPhoneConfigRequest
- func (c *Client) UpdateUserRoutingProfileRequest(input *UpdateUserRoutingProfileInput) UpdateUserRoutingProfileRequest
- func (c *Client) UpdateUserSecurityProfilesRequest(input *UpdateUserSecurityProfilesInput) UpdateUserSecurityProfilesRequest
- type Comparison
- type ContactFlowSummary
- type ContactFlowType
- type CreateUserInput
- type CreateUserOutput
- type CreateUserRequest
- type CreateUserResponse
- type Credentials
- type CurrentMetric
- type CurrentMetricData
- type CurrentMetricName
- type CurrentMetricResult
- type DeleteUserInput
- type DeleteUserOutput
- type DeleteUserRequest
- type DeleteUserResponse
- type DescribeUserHierarchyGroupInput
- type DescribeUserHierarchyGroupOutput
- type DescribeUserHierarchyGroupRequest
- type DescribeUserHierarchyGroupResponse
- type DescribeUserHierarchyStructureInput
- type DescribeUserHierarchyStructureOutput
- type DescribeUserHierarchyStructureRequest
- type DescribeUserHierarchyStructureResponse
- type DescribeUserInput
- type DescribeUserOutput
- type DescribeUserRequest
- type DescribeUserResponse
- type Dimensions
- type Filters
- type GetContactAttributesInput
- type GetContactAttributesOutput
- type GetContactAttributesRequest
- type GetContactAttributesResponse
- type GetCurrentMetricDataInput
- type GetCurrentMetricDataOutput
- type GetCurrentMetricDataPaginator
- type GetCurrentMetricDataRequest
- type GetCurrentMetricDataResponse
- type GetFederationTokenInput
- type GetFederationTokenOutput
- type GetFederationTokenRequest
- type GetFederationTokenResponse
- type GetMetricDataInput
- type GetMetricDataOutput
- type GetMetricDataPaginator
- type GetMetricDataRequest
- type GetMetricDataResponse
- type Grouping
- type HierarchyGroup
- type HierarchyGroupSummary
- type HierarchyLevel
- type HierarchyPath
- type HierarchyStructure
- type HistoricalMetric
- type HistoricalMetricData
- type HistoricalMetricName
- type HistoricalMetricResult
- type HoursOfOperationSummary
- type ListContactFlowsInput
- type ListContactFlowsOutput
- type ListContactFlowsPaginator
- type ListContactFlowsRequest
- type ListContactFlowsResponse
- type ListHoursOfOperationsInput
- type ListHoursOfOperationsOutput
- type ListHoursOfOperationsPaginator
- type ListHoursOfOperationsRequest
- type ListHoursOfOperationsResponse
- type ListPhoneNumbersInput
- type ListPhoneNumbersOutput
- type ListPhoneNumbersPaginator
- type ListPhoneNumbersRequest
- type ListPhoneNumbersResponse
- type ListQueuesInput
- type ListQueuesOutput
- type ListQueuesPaginator
- type ListQueuesRequest
- type ListQueuesResponse
- type ListRoutingProfilesInput
- type ListRoutingProfilesOutput
- type ListRoutingProfilesPaginator
- type ListRoutingProfilesRequest
- type ListRoutingProfilesResponse
- type ListSecurityProfilesInput
- type ListSecurityProfilesOutput
- type ListSecurityProfilesPaginator
- type ListSecurityProfilesRequest
- type ListSecurityProfilesResponse
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type ListUserHierarchyGroupsInput
- type ListUserHierarchyGroupsOutput
- type ListUserHierarchyGroupsPaginator
- type ListUserHierarchyGroupsRequest
- type ListUserHierarchyGroupsResponse
- type ListUsersInput
- type ListUsersOutput
- type ListUsersPaginator
- type ListUsersRequest
- type ListUsersResponse
- type ParticipantDetails
- type PhoneNumberCountryCode
- type PhoneNumberSummary
- type PhoneNumberType
- type PhoneType
- type QueueReference
- type QueueSummary
- type QueueType
- type RoutingProfileSummary
- type SecurityProfileSummary
- type StartChatContactInput
- type StartChatContactOutput
- type StartChatContactRequest
- type StartChatContactResponse
- type StartOutboundVoiceContactInput
- type StartOutboundVoiceContactOutput
- type StartOutboundVoiceContactRequest
- type StartOutboundVoiceContactResponse
- type Statistic
- type StopContactInput
- type StopContactOutput
- type StopContactRequest
- type StopContactResponse
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type Threshold
- type Unit
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdateContactAttributesInput
- type UpdateContactAttributesOutput
- type UpdateContactAttributesRequest
- type UpdateContactAttributesResponse
- type UpdateUserHierarchyInput
- type UpdateUserHierarchyOutput
- type UpdateUserHierarchyRequest
- type UpdateUserHierarchyResponse
- type UpdateUserIdentityInfoInput
- type UpdateUserIdentityInfoOutput
- type UpdateUserIdentityInfoRequest
- type UpdateUserIdentityInfoResponse
- type UpdateUserPhoneConfigInput
- type UpdateUserPhoneConfigOutput
- type UpdateUserPhoneConfigRequest
- type UpdateUserPhoneConfigResponse
- type UpdateUserRoutingProfileInput
- type UpdateUserRoutingProfileOutput
- type UpdateUserRoutingProfileRequest
- type UpdateUserRoutingProfileResponse
- type UpdateUserSecurityProfilesInput
- type UpdateUserSecurityProfilesOutput
- type UpdateUserSecurityProfilesRequest
- type UpdateUserSecurityProfilesResponse
- type User
- type UserIdentityInfo
- type UserPhoneConfig
- type UserSummary
Constants ¶
const ( ServiceName = "Amazon Connect" // Service's name ServiceID = "Connect" // Service's identifier EndpointsID = "connect" // Service's Endpoint identifier )
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 the specified 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 specified parameters 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 exceeded. 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 ChatMessage ¶ added in v0.18.0
type ChatMessage struct { // The content of the chat message. // // Content is a required field Content *string `min:"1" type:"string" required:"true"` // The type of the content. Supported types are text/plain. // // ContentType is a required field ContentType *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A chat message.
func (ChatMessage) MarshalFields ¶ added in v0.18.0
func (s ChatMessage) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ChatMessage) String ¶ added in v0.18.0
func (s ChatMessage) String() string
String returns the string representation
func (*ChatMessage) Validate ¶ added in v0.18.0
func (s *ChatMessage) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Client ¶ added in v0.9.0
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 ¶
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 user account for the specified 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 the specified Amazon Connect instance.
// 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.
Describes the specified hierarchy group.
// 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.
Describes the hierarchy structure of the specified Amazon Connect instance.
// 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.
Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
// 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 for the specified 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.
Gets the real-time metric data from the specified Amazon Connect instance.
For more information, see Real-time Metrics Reports (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-reports.html) in the Amazon Connect Administrator Guide.
// 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.
Gets historical metric data from the specified Amazon Connect instance.
For more information, see Historical Metrics Reports (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html) in the Amazon Connect Administrator Guide.
// 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) ListContactFlowsRequest ¶ added in v0.16.0
func (c *Client) ListContactFlowsRequest(input *ListContactFlowsInput) ListContactFlowsRequest
ListContactFlowsRequest returns a request value for making API operation for Amazon Connect Service.
Provides information about the contact flows for the specified Amazon Connect instance.
// Example sending a request using ListContactFlowsRequest. req := client.ListContactFlowsRequest(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/ListContactFlows
func (*Client) ListHoursOfOperationsRequest ¶ added in v0.16.0
func (c *Client) ListHoursOfOperationsRequest(input *ListHoursOfOperationsInput) ListHoursOfOperationsRequest
ListHoursOfOperationsRequest returns a request value for making API operation for Amazon Connect Service.
Provides information about the hours of operation for the specified Amazon Connect instance.
// Example sending a request using ListHoursOfOperationsRequest. req := client.ListHoursOfOperationsRequest(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/ListHoursOfOperations
func (*Client) ListPhoneNumbersRequest ¶ added in v0.16.0
func (c *Client) ListPhoneNumbersRequest(input *ListPhoneNumbersInput) ListPhoneNumbersRequest
ListPhoneNumbersRequest returns a request value for making API operation for Amazon Connect Service.
Provides information about the phone numbers for the specified Amazon Connect instance.
// Example sending a request using ListPhoneNumbersRequest. req := client.ListPhoneNumbersRequest(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/ListPhoneNumbers
func (*Client) ListQueuesRequest ¶ added in v0.16.0
func (c *Client) ListQueuesRequest(input *ListQueuesInput) ListQueuesRequest
ListQueuesRequest returns a request value for making API operation for Amazon Connect Service.
Provides information about the queues for the specified Amazon Connect instance.
// Example sending a request using ListQueuesRequest. req := client.ListQueuesRequest(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/ListQueues
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.
Provides summary information about the routing profiles for the specified Amazon Connect 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.
Provides summary information about the security profiles for the specified Amazon Connect instance.
// 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) ListTagsForResourceRequest ¶ added in v0.17.0
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for Amazon Connect Service.
Lists the tags for the specified resource.
// Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(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/ListTagsForResource
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.
Provides summary information about the hierarchy groups for the specified Amazon Connect 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.
Provides summary information about the users for the specified Amazon Connect instance.
// 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) StartChatContactRequest ¶ added in v0.18.0
func (c *Client) StartChatContactRequest(input *StartChatContactInput) StartChatContactRequest
StartChatContactRequest returns a request value for making API operation for Amazon Connect Service.
Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) with WEBSOCKET and CONNECTION_CREDENTIALS.
// Example sending a request using StartChatContactRequest. req := client.StartChatContactRequest(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/StartChatContact
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.
Initiates a contact flow to place an outbound call to a customer.
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it 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 specified contact.
// 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) TagResourceRequest ¶ added in v0.17.0
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for Amazon Connect Service.
Adds the specified tags to the specified resource.
The supported resource type is users.
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(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/TagResource
func (*Client) UntagResourceRequest ¶ added in v0.17.0
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for Amazon Connect Service.
Removes the specified tags from the specified resource.
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(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/UntagResource
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.
Creates or updates the contact attributes associated with the specified contact.
You can 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 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 specified 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.
// 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 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 the specified 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.
Assigns the specified security profiles to the specified 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 ContactFlowSummary ¶ added in v0.16.0
type ContactFlowSummary struct { // The Amazon Resource Name (ARN) of the contact flow. Arn *string `type:"string"` // The type of contact flow. ContactFlowType ContactFlowType `type:"string" enum:"true"` // The identifier of the contact flow. Id *string `type:"string"` // The name of the contact flow. Name *string `type:"string"` // contains filtered or unexported fields }
Contains summary information about a contact flow.
func (ContactFlowSummary) MarshalFields ¶ added in v0.16.0
func (s ContactFlowSummary) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ContactFlowSummary) String ¶ added in v0.16.0
func (s ContactFlowSummary) String() string
String returns the string representation
type ContactFlowType ¶ added in v0.16.0
type ContactFlowType string
const ( ContactFlowTypeContactFlow ContactFlowType = "CONTACT_FLOW" ContactFlowTypeCustomerQueue ContactFlowType = "CUSTOMER_QUEUE" ContactFlowTypeCustomerHold ContactFlowType = "CUSTOMER_HOLD" ContactFlowTypeCustomerWhisper ContactFlowType = "CUSTOMER_WHISPER" ContactFlowTypeAgentHold ContactFlowType = "AGENT_HOLD" ContactFlowTypeAgentWhisper ContactFlowType = "AGENT_WHISPER" ContactFlowTypeOutboundWhisper ContactFlowType = "OUTBOUND_WHISPER" ContactFlowTypeAgentTransfer ContactFlowType = "AGENT_TRANSFER" ContactFlowTypeQueueTransfer ContactFlowType = "QUEUE_TRANSFER" )
Enum values for ContactFlowType
func (ContactFlowType) MarshalValue ¶ added in v0.16.0
func (enum ContactFlowType) MarshalValue() (string, error)
func (ContactFlowType) MarshalValueBuf ¶ added in v0.16.0
func (enum ContactFlowType) MarshalValueBuf(b []byte) ([]byte, error)
type CreateUserInput ¶ added in v0.5.0
type CreateUserInput struct { // The identifier of the user account in the directory used for identity management. // If Amazon Connect cannot access the directory, you can specify this identifier // to authenticate users. If you include the identifier, we assume that Amazon // Connect cannot access the directory. Otherwise, the identity information // is used to authenticate users from your directory. // // This parameter is required if you are using an existing directory for identity // management in Amazon Connect when Amazon Connect cannot access your directory // to authenticate users. If you are using SAML for identity management and // include this parameter, an error is returned. DirectoryUserId *string `type:"string"` // The identifier of the hierarchy group for the user. HierarchyGroupId *string `type:"string"` // The information about the identity of the user. IdentityInfo *UserIdentityInfo `type:"structure"` // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The password for the user account. A password is required if you are using // Amazon Connect for identity management. Otherwise, it is an error to include // a password. Password *string `type:"string"` // The phone settings for the user. // // PhoneConfig is a required field PhoneConfig *UserPhoneConfig `type:"structure" required:"true"` // The identifier of the routing profile for the user. // // RoutingProfileId is a required field RoutingProfileId *string `type:"string" required:"true"` // The identifier of the security profile for the user. // // SecurityProfileIds is a required field SecurityProfileIds []string `min:"1" type:"list" required:"true"` // One or more tags. Tags map[string]string `min:"1" type:"map"` // The user name for the account. For instances not using SAML for identity // management, the user name can include up to 20 characters. If you are using // SAML for identity management, the user name can include up to 64 characters // from [a-zA-Z0-9_-.\@]+. // // Username 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. UserArn *string `type:"string"` // The identifier of the user account. 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 }
Contains 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 }
Contains information about a real-time 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 { // Information about the metric. Metric *CurrentMetric `type:"structure"` // The value of the metric. Value *float64 `type:"double"` // contains filtered or unexported fields }
Contains the data for a real-time metric.
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
The 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" CurrentMetricNameAgentsOnContact CurrentMetricName = "AGENTS_ON_CONTACT" CurrentMetricNameSlotsActive CurrentMetricName = "SLOTS_ACTIVE" CurrentMetricNameSlotsAvailable CurrentMetricName = "SLOTS_AVAILABLE" )
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 set of metrics. Collections []CurrentMetricData `type:"list"` // The dimensions for the metrics. Dimensions *Dimensions `type:"structure"` // contains filtered or unexported fields }
Contains information about a set of real-time metrics.
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 of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifier of the user. // // 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 of the hierarchy group. // // HierarchyGroupId is a required field HierarchyGroupId *string `location:"uri" locationName:"HierarchyGroupId" type:"string" required:"true"` // The identifier of the Amazon Connect instance. // // 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 { // Information about the hierarchy group. 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 of the Amazon Connect instance. // // 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 { // Information about the hierarchy structure. 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 of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifier of the user account. // // 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 { // 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. Channel Channel `type:"string" enum:"true"` // Information about the queue for which metrics are returned. Queue *QueueReference `type:"structure"` // contains filtered or unexported fields }
Contains information about the dimensions for a set of metrics.
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 to filter the metrics. Channels []Channel `type:"list"` // The queues to use to filter the metrics. You can specify up to 100 queues // per request. Queues []string `min:"1" type:"list"` // contains filtered or unexported fields }
Contains the filter to apply when retrieving metrics.
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.
type GetContactAttributesInput ¶ added in v0.7.0
type GetContactAttributesInput struct { // The identifier of the initial contact. // // InitialContactId is a required field InitialContactId *string `location:"uri" locationName:"InitialContactId" min:"1" type:"string" required:"true"` // The identifier of the Amazon Connect instance. // // 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 { // Information about the attributes. 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 { // The metrics to retrieve. Specify the name and unit for each metric. The following // metrics are available: // // AGENTS_AFTER_CONTACT_WORK // // Unit: COUNT // // AGENTS_AVAILABLE // // Unit: COUNT // // AGENTS_ERROR // // Unit: COUNT // // AGENTS_NON_PRODUCTIVE // // Unit: COUNT // // AGENTS_ON_CALL // // Unit: COUNT // // AGENTS_ON_CONTACT // // Unit: COUNT // // AGENTS_ONLINE // // Unit: COUNT // // AGENTS_STAFFED // // Unit: COUNT // // CONTACTS_IN_QUEUE // // Unit: COUNT // // CONTACTS_SCHEDULED // // Unit: COUNT // // OLDEST_CONTACT_AGE // // Unit: SECONDS // // SLOTS_ACTIVE // // Unit: COUNT // // SLOTS_AVAILABLE // // Unit: COUNT // // CurrentMetrics is a required field CurrentMetrics []CurrentMetric `type:"list" required:"true"` // The queues, up to 100, or channels, to use to filter the metrics returned. // Metric data is retrieved only for the resources associated with the queues // or channels included in the filter. You can include both queue IDs and queue // ARNs in the same request. The only supported channel is VOICE. // // 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 metrics is returned. Groupings []Grouping `type:"list"` // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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 token 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 the metrics were retrieved and cached for pagination. DataSnapshotTime *time.Time `type:"timestamp"` // Information about the real-time metrics. MetricResults []CurrentMetricResult `type:"list"` // If there are additional results, this is the token for the next set of results. // // The token expires after 5 minutes from the time it is created. Subsequent // requests that use the token must use the same request parameters as the request // that generated the token. NextToken *string `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
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 of the Amazon Connect instance. // // 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 start time timestamp. // // The time range between the start and end time must be less than 24 hours. // // EndTime is a required field EndTime *time.Time `type:"timestamp" required:"true"` // The queues, up to 100, or channels, to use to filter the metrics returned. // Metric data is retrieved only for the resources associated with the queues // or channels included in the filter. You can include both queue IDs and queue // ARNs in the same request. The only supported channel is VOICE. // // 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 queue, the metrics returned are grouped by queue. The values returned // apply to the metrics for each queue rather than aggregated for all queues. // // The only supported grouping is QUEUE. // // If no grouping is specified, a summary of metrics for all queues is returned. Groupings []Grouping `type:"list"` // The metrics to retrieve. Specify the name, unit, and statistic for each metric. // The following historical metrics are available: // // ABANDON_TIME // // Unit: SECONDS // // Statistic: AVG // // AFTER_CONTACT_WORK_TIME // // Unit: SECONDS // // Statistic: AVG // // API_CONTACTS_HANDLED // // Unit: COUNT // // Statistic: SUM // // CALLBACK_CONTACTS_HANDLED // // Unit: COUNT // // Statistic: SUM // // CONTACTS_ABANDONED // // Unit: COUNT // // Statistic: SUM // // CONTACTS_AGENT_HUNG_UP_FIRST // // Unit: COUNT // // Statistic: SUM // // CONTACTS_CONSULTED // // Unit: COUNT // // Statistic: SUM // // CONTACTS_HANDLED // // Unit: COUNT // // Statistic: SUM // // CONTACTS_HANDLED_INCOMING // // Unit: COUNT // // Statistic: SUM // // CONTACTS_HANDLED_OUTBOUND // // Unit: COUNT // // Statistic: SUM // // CONTACTS_HOLD_ABANDONS // // Unit: COUNT // // Statistic: SUM // // CONTACTS_MISSED // // Unit: COUNT // // Statistic: SUM // // CONTACTS_QUEUED // // Unit: COUNT // // Statistic: SUM // // CONTACTS_TRANSFERRED_IN // // Unit: COUNT // // Statistic: SUM // // CONTACTS_TRANSFERRED_IN_FROM_QUEUE // // Unit: COUNT // // Statistic: SUM // // CONTACTS_TRANSFERRED_OUT // // Unit: COUNT // // Statistic: SUM // // CONTACTS_TRANSFERRED_OUT_FROM_QUEUE // // Unit: COUNT // // Statistic: SUM // // HANDLE_TIME // // Unit: SECONDS // // Statistic: AVG // // HOLD_TIME // // Unit: SECONDS // // Statistic: AVG // // INTERACTION_AND_HOLD_TIME // // Unit: SECONDS // // Statistic: AVG // // INTERACTION_TIME // // Unit: SECONDS // // Statistic: AVG // // OCCUPANCY // // Unit: PERCENT // // Statistic: AVG // // QUEUE_ANSWER_TIME // // Unit: SECONDS // // Statistic: AVG // // QUEUED_TIME // // Unit: SECONDS // // Statistic: MAX // // SERVICE_LEVEL // // Unit: PERCENT // // Statistic: 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 of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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. // // The start time cannot be earlier than 24 hours before the time of the request. // Historical metrics are available 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 { // Information about the historical metrics. // // If no grouping is specified, a summary of metric data is returned. MetricResults []HistoricalMetricResult `type:"list"` // If there are additional results, this is the token for the next set of results. // // The token expires after 5 minutes from the time it is created. Subsequent // requests that use the token must use the same request parameters as the request // that generated the token. NextToken *string `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
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
Enum values for Grouping
func (Grouping) MarshalValue ¶ added in v0.5.0
type HierarchyGroup ¶ added in v0.5.0
type HierarchyGroup struct { // The Amazon Resource Name (ARN) of the hierarchy group. Arn *string `type:"string"` // Information about the levels in the hierarchy group. HierarchyPath *HierarchyPath `type:"structure"` // The identifier of the hierarchy group. Id *string `type:"string"` // The identifier of the level in the hierarchy group. LevelId *string `type:"string"` // The name of the hierarchy group. Name *string `type:"string"` // contains filtered or unexported fields }
Contains information about a hierarchy group.
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 Amazon Resource Name (ARN) of 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 }
Contains summary information about a hierarchy group.
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 Amazon Resource Name (ARN) of the hierarchy level. Arn *string `type:"string"` // The identifier of the hierarchy level. Id *string `type:"string"` // The name of the hierarchy level. Name *string `type:"string"` // contains filtered or unexported fields }
Contains information about a hierarchy level.
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 { // Information about level five. LevelFive *HierarchyGroupSummary `type:"structure"` // Information about level four. LevelFour *HierarchyGroupSummary `type:"structure"` // Information about level one. LevelOne *HierarchyGroupSummary `type:"structure"` // Information about level three. LevelThree *HierarchyGroupSummary `type:"structure"` // Information about level two. LevelTwo *HierarchyGroupSummary `type:"structure"` // contains filtered or unexported fields }
Contains information about the levels of a 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 { // Information about level five. LevelFive *HierarchyLevel `type:"structure"` // Information about level four. LevelFour *HierarchyLevel `type:"structure"` // Information about level one. LevelOne *HierarchyLevel `type:"structure"` // Information about level three. LevelThree *HierarchyLevel `type:"structure"` // Information about level two. LevelTwo *HierarchyLevel `type:"structure"` // contains filtered or unexported fields }
Contains information about a hierarchy 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 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 }
Contains information about a historical 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 { // Information about the metric. Metric *HistoricalMetric `type:"structure"` // The value of the metric. Value *float64 `type:"double"` // contains filtered or unexported fields }
Contains the data for a historical metric.
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
The 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 { // The set of metrics. Collections []HistoricalMetricData `type:"list"` // The dimension for the metrics. Dimensions *Dimensions `type:"structure"` // contains filtered or unexported fields }
Contains information about the historical metrics retrieved.
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 HoursOfOperationSummary ¶ added in v0.16.0
type HoursOfOperationSummary struct { // The Amazon Resource Name (ARN) of the hours of operation. Arn *string `type:"string"` // The identifier of the hours of operation. Id *string `type:"string"` // The name of the hours of operation. Name *string `type:"string"` // contains filtered or unexported fields }
Contains summary information about hours of operation for a contact center.
func (HoursOfOperationSummary) MarshalFields ¶ added in v0.16.0
func (s HoursOfOperationSummary) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (HoursOfOperationSummary) String ¶ added in v0.16.0
func (s HoursOfOperationSummary) String() string
String returns the string representation
type ListContactFlowsInput ¶ added in v0.16.0
type ListContactFlowsInput struct { // The type of contact flow. ContactFlowTypes []ContactFlowType `location:"querystring" locationName:"contactFlowTypes" type:"list"` // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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 (ListContactFlowsInput) MarshalFields ¶ added in v0.16.0
func (s ListContactFlowsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListContactFlowsInput) String ¶ added in v0.16.0
func (s ListContactFlowsInput) String() string
String returns the string representation
func (*ListContactFlowsInput) Validate ¶ added in v0.16.0
func (s *ListContactFlowsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListContactFlowsOutput ¶ added in v0.16.0
type ListContactFlowsOutput struct { // Information about the contact flows. ContactFlowSummaryList []ContactFlowSummary `type:"list"` // If there are additional results, this is the token for the next set of results. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListContactFlowsOutput) MarshalFields ¶ added in v0.16.0
func (s ListContactFlowsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListContactFlowsOutput) String ¶ added in v0.16.0
func (s ListContactFlowsOutput) String() string
String returns the string representation
type ListContactFlowsPaginator ¶ added in v0.16.0
ListContactFlowsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListContactFlowsPaginator ¶ added in v0.16.0
func NewListContactFlowsPaginator(req ListContactFlowsRequest) ListContactFlowsPaginator
NewListContactFlowsRequestPaginator returns a paginator for ListContactFlows. 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.ListContactFlowsRequest(input) p := connect.NewListContactFlowsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListContactFlowsPaginator) CurrentPage ¶ added in v0.16.0
func (p *ListContactFlowsPaginator) CurrentPage() *ListContactFlowsOutput
type ListContactFlowsRequest ¶ added in v0.16.0
type ListContactFlowsRequest struct { *aws.Request Input *ListContactFlowsInput Copy func(*ListContactFlowsInput) ListContactFlowsRequest }
ListContactFlowsRequest is the request type for the ListContactFlows API operation.
func (ListContactFlowsRequest) Send ¶ added in v0.16.0
func (r ListContactFlowsRequest) Send(ctx context.Context) (*ListContactFlowsResponse, error)
Send marshals and sends the ListContactFlows API request.
type ListContactFlowsResponse ¶ added in v0.16.0
type ListContactFlowsResponse struct { *ListContactFlowsOutput // contains filtered or unexported fields }
ListContactFlowsResponse is the response type for the ListContactFlows API operation.
func (*ListContactFlowsResponse) SDKResponseMetdata ¶ added in v0.16.0
func (r *ListContactFlowsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListContactFlows request.
type ListHoursOfOperationsInput ¶ added in v0.16.0
type ListHoursOfOperationsInput struct { // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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 (ListHoursOfOperationsInput) MarshalFields ¶ added in v0.16.0
func (s ListHoursOfOperationsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListHoursOfOperationsInput) String ¶ added in v0.16.0
func (s ListHoursOfOperationsInput) String() string
String returns the string representation
func (*ListHoursOfOperationsInput) Validate ¶ added in v0.16.0
func (s *ListHoursOfOperationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListHoursOfOperationsOutput ¶ added in v0.16.0
type ListHoursOfOperationsOutput struct { // Information about the hours of operation. HoursOfOperationSummaryList []HoursOfOperationSummary `type:"list"` // If there are additional results, this is the token for the next set of results. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListHoursOfOperationsOutput) MarshalFields ¶ added in v0.16.0
func (s ListHoursOfOperationsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListHoursOfOperationsOutput) String ¶ added in v0.16.0
func (s ListHoursOfOperationsOutput) String() string
String returns the string representation
type ListHoursOfOperationsPaginator ¶ added in v0.16.0
ListHoursOfOperationsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListHoursOfOperationsPaginator ¶ added in v0.16.0
func NewListHoursOfOperationsPaginator(req ListHoursOfOperationsRequest) ListHoursOfOperationsPaginator
NewListHoursOfOperationsRequestPaginator returns a paginator for ListHoursOfOperations. 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.ListHoursOfOperationsRequest(input) p := connect.NewListHoursOfOperationsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListHoursOfOperationsPaginator) CurrentPage ¶ added in v0.16.0
func (p *ListHoursOfOperationsPaginator) CurrentPage() *ListHoursOfOperationsOutput
type ListHoursOfOperationsRequest ¶ added in v0.16.0
type ListHoursOfOperationsRequest struct { *aws.Request Input *ListHoursOfOperationsInput Copy func(*ListHoursOfOperationsInput) ListHoursOfOperationsRequest }
ListHoursOfOperationsRequest is the request type for the ListHoursOfOperations API operation.
func (ListHoursOfOperationsRequest) Send ¶ added in v0.16.0
func (r ListHoursOfOperationsRequest) Send(ctx context.Context) (*ListHoursOfOperationsResponse, error)
Send marshals and sends the ListHoursOfOperations API request.
type ListHoursOfOperationsResponse ¶ added in v0.16.0
type ListHoursOfOperationsResponse struct { *ListHoursOfOperationsOutput // contains filtered or unexported fields }
ListHoursOfOperationsResponse is the response type for the ListHoursOfOperations API operation.
func (*ListHoursOfOperationsResponse) SDKResponseMetdata ¶ added in v0.16.0
func (r *ListHoursOfOperationsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListHoursOfOperations request.
type ListPhoneNumbersInput ¶ added in v0.16.0
type ListPhoneNumbersInput struct { // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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"` // The ISO country code. PhoneNumberCountryCodes []PhoneNumberCountryCode `location:"querystring" locationName:"phoneNumberCountryCodes" type:"list"` // The type of phone number. PhoneNumberTypes []PhoneNumberType `location:"querystring" locationName:"phoneNumberTypes" type:"list"` // contains filtered or unexported fields }
func (ListPhoneNumbersInput) MarshalFields ¶ added in v0.16.0
func (s ListPhoneNumbersInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListPhoneNumbersInput) String ¶ added in v0.16.0
func (s ListPhoneNumbersInput) String() string
String returns the string representation
func (*ListPhoneNumbersInput) Validate ¶ added in v0.16.0
func (s *ListPhoneNumbersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPhoneNumbersOutput ¶ added in v0.16.0
type ListPhoneNumbersOutput struct { // If there are additional results, this is the token for the next set of results. NextToken *string `type:"string"` // Information about the phone numbers. PhoneNumberSummaryList []PhoneNumberSummary `type:"list"` // contains filtered or unexported fields }
func (ListPhoneNumbersOutput) MarshalFields ¶ added in v0.16.0
func (s ListPhoneNumbersOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListPhoneNumbersOutput) String ¶ added in v0.16.0
func (s ListPhoneNumbersOutput) String() string
String returns the string representation
type ListPhoneNumbersPaginator ¶ added in v0.16.0
ListPhoneNumbersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListPhoneNumbersPaginator ¶ added in v0.16.0
func NewListPhoneNumbersPaginator(req ListPhoneNumbersRequest) ListPhoneNumbersPaginator
NewListPhoneNumbersRequestPaginator returns a paginator for ListPhoneNumbers. 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.ListPhoneNumbersRequest(input) p := connect.NewListPhoneNumbersRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListPhoneNumbersPaginator) CurrentPage ¶ added in v0.16.0
func (p *ListPhoneNumbersPaginator) CurrentPage() *ListPhoneNumbersOutput
type ListPhoneNumbersRequest ¶ added in v0.16.0
type ListPhoneNumbersRequest struct { *aws.Request Input *ListPhoneNumbersInput Copy func(*ListPhoneNumbersInput) ListPhoneNumbersRequest }
ListPhoneNumbersRequest is the request type for the ListPhoneNumbers API operation.
func (ListPhoneNumbersRequest) Send ¶ added in v0.16.0
func (r ListPhoneNumbersRequest) Send(ctx context.Context) (*ListPhoneNumbersResponse, error)
Send marshals and sends the ListPhoneNumbers API request.
type ListPhoneNumbersResponse ¶ added in v0.16.0
type ListPhoneNumbersResponse struct { *ListPhoneNumbersOutput // contains filtered or unexported fields }
ListPhoneNumbersResponse is the response type for the ListPhoneNumbers API operation.
func (*ListPhoneNumbersResponse) SDKResponseMetdata ¶ added in v0.16.0
func (r *ListPhoneNumbersResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListPhoneNumbers request.
type ListQueuesInput ¶ added in v0.16.0
type ListQueuesInput struct { // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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"` // The type of queue. QueueTypes []QueueType `location:"querystring" locationName:"queueTypes" type:"list"` // contains filtered or unexported fields }
func (ListQueuesInput) MarshalFields ¶ added in v0.16.0
func (s ListQueuesInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListQueuesInput) String ¶ added in v0.16.0
func (s ListQueuesInput) String() string
String returns the string representation
func (*ListQueuesInput) Validate ¶ added in v0.16.0
func (s *ListQueuesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListQueuesOutput ¶ added in v0.16.0
type ListQueuesOutput struct { // If there are additional results, this is the token for the next set of results. NextToken *string `type:"string"` // Information about the queues. QueueSummaryList []QueueSummary `type:"list"` // contains filtered or unexported fields }
func (ListQueuesOutput) MarshalFields ¶ added in v0.16.0
func (s ListQueuesOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListQueuesOutput) String ¶ added in v0.16.0
func (s ListQueuesOutput) String() string
String returns the string representation
type ListQueuesPaginator ¶ added in v0.16.0
ListQueuesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListQueuesPaginator ¶ added in v0.16.0
func NewListQueuesPaginator(req ListQueuesRequest) ListQueuesPaginator
NewListQueuesRequestPaginator returns a paginator for ListQueues. 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.ListQueuesRequest(input) p := connect.NewListQueuesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListQueuesPaginator) CurrentPage ¶ added in v0.16.0
func (p *ListQueuesPaginator) CurrentPage() *ListQueuesOutput
type ListQueuesRequest ¶ added in v0.16.0
type ListQueuesRequest struct { *aws.Request Input *ListQueuesInput Copy func(*ListQueuesInput) ListQueuesRequest }
ListQueuesRequest is the request type for the ListQueues API operation.
func (ListQueuesRequest) Send ¶ added in v0.16.0
func (r ListQueuesRequest) Send(ctx context.Context) (*ListQueuesResponse, error)
Send marshals and sends the ListQueues API request.
type ListQueuesResponse ¶ added in v0.16.0
type ListQueuesResponse struct { *ListQueuesOutput // contains filtered or unexported fields }
ListQueuesResponse is the response type for the ListQueues API operation.
func (*ListQueuesResponse) SDKResponseMetdata ¶ added in v0.16.0
func (r *ListQueuesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListQueues request.
type ListRoutingProfilesInput ¶ added in v0.5.0
type ListRoutingProfilesInput struct { // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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 { // If there are additional results, this is the token for the next set of results. NextToken *string `type:"string"` // Information about the routing profiles. 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 ListRoutingProfilesPaginator ¶ added in v0.16.0
ListRoutingProfilesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListRoutingProfilesPaginator ¶ added in v0.16.0
func NewListRoutingProfilesPaginator(req ListRoutingProfilesRequest) ListRoutingProfilesPaginator
NewListRoutingProfilesRequestPaginator returns a paginator for ListRoutingProfiles. 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.ListRoutingProfilesRequest(input) p := connect.NewListRoutingProfilesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListRoutingProfilesPaginator) CurrentPage ¶ added in v0.16.0
func (p *ListRoutingProfilesPaginator) CurrentPage() *ListRoutingProfilesOutput
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 of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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 { // If there are additional results, this is the token for the next set of results. NextToken *string `type:"string"` // Information about the security profiles. 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 ListSecurityProfilesPaginator ¶ added in v0.16.0
ListSecurityProfilesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListSecurityProfilesPaginator ¶ added in v0.16.0
func NewListSecurityProfilesPaginator(req ListSecurityProfilesRequest) ListSecurityProfilesPaginator
NewListSecurityProfilesRequestPaginator returns a paginator for ListSecurityProfiles. 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.ListSecurityProfilesRequest(input) p := connect.NewListSecurityProfilesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListSecurityProfilesPaginator) CurrentPage ¶ added in v0.16.0
func (p *ListSecurityProfilesPaginator) CurrentPage() *ListSecurityProfilesOutput
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 ListTagsForResourceInput ¶ added in v0.17.0
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) MarshalFields ¶ added in v0.17.0
func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForResourceInput) String ¶ added in v0.17.0
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶ added in v0.17.0
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v0.17.0
type ListTagsForResourceOutput struct { // Information about the tags. Tags map[string]string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) MarshalFields ¶ added in v0.17.0
func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForResourceOutput) String ¶ added in v0.17.0
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourceRequest ¶ added in v0.17.0
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶ added in v0.17.0
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶ added in v0.17.0
type ListTagsForResourceResponse struct { *ListTagsForResourceOutput // contains filtered or unexported fields }
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
func (*ListTagsForResourceResponse) SDKResponseMetdata ¶ added in v0.17.0
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource request.
type ListUserHierarchyGroupsInput ¶ added in v0.5.0
type ListUserHierarchyGroupsInput struct { // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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 { // If there are additional results, this is the token for the next set of results. NextToken *string `type:"string"` // Information about the hierarchy groups. 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 ListUserHierarchyGroupsPaginator ¶ added in v0.16.0
ListUserHierarchyGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListUserHierarchyGroupsPaginator ¶ added in v0.16.0
func NewListUserHierarchyGroupsPaginator(req ListUserHierarchyGroupsRequest) ListUserHierarchyGroupsPaginator
NewListUserHierarchyGroupsRequestPaginator returns a paginator for ListUserHierarchyGroups. 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.ListUserHierarchyGroupsRequest(input) p := connect.NewListUserHierarchyGroupsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListUserHierarchyGroupsPaginator) CurrentPage ¶ added in v0.16.0
func (p *ListUserHierarchyGroupsPaginator) CurrentPage() *ListUserHierarchyGroupsOutput
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 of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximimum number of results to return per page. 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 { // If there are additional results, this is the token for the next set of results. NextToken *string `type:"string"` // Information about the users. 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 ListUsersPaginator ¶ added in v0.16.0
ListUsersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListUsersPaginator ¶ added in v0.16.0
func NewListUsersPaginator(req ListUsersRequest) ListUsersPaginator
NewListUsersRequestPaginator returns a paginator for ListUsers. 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.ListUsersRequest(input) p := connect.NewListUsersRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListUsersPaginator) CurrentPage ¶ added in v0.16.0
func (p *ListUsersPaginator) CurrentPage() *ListUsersOutput
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 ParticipantDetails ¶ added in v0.18.0
type ParticipantDetails struct { // Display name of the participant. // // DisplayName is a required field DisplayName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The customer's details.
func (ParticipantDetails) MarshalFields ¶ added in v0.18.0
func (s ParticipantDetails) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ParticipantDetails) String ¶ added in v0.18.0
func (s ParticipantDetails) String() string
String returns the string representation
func (*ParticipantDetails) Validate ¶ added in v0.18.0
func (s *ParticipantDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PhoneNumberCountryCode ¶ added in v0.16.0
type PhoneNumberCountryCode string
const ( PhoneNumberCountryCodeAf PhoneNumberCountryCode = "AF" PhoneNumberCountryCodeAl PhoneNumberCountryCode = "AL" PhoneNumberCountryCodeDz PhoneNumberCountryCode = "DZ" PhoneNumberCountryCodeAs PhoneNumberCountryCode = "AS" PhoneNumberCountryCodeAd PhoneNumberCountryCode = "AD" PhoneNumberCountryCodeAo PhoneNumberCountryCode = "AO" PhoneNumberCountryCodeAi PhoneNumberCountryCode = "AI" PhoneNumberCountryCodeAq PhoneNumberCountryCode = "AQ" PhoneNumberCountryCodeAg PhoneNumberCountryCode = "AG" PhoneNumberCountryCodeAr PhoneNumberCountryCode = "AR" PhoneNumberCountryCodeAm PhoneNumberCountryCode = "AM" PhoneNumberCountryCodeAw PhoneNumberCountryCode = "AW" PhoneNumberCountryCodeAu PhoneNumberCountryCode = "AU" PhoneNumberCountryCodeAt PhoneNumberCountryCode = "AT" PhoneNumberCountryCodeAz PhoneNumberCountryCode = "AZ" PhoneNumberCountryCodeBs PhoneNumberCountryCode = "BS" PhoneNumberCountryCodeBh PhoneNumberCountryCode = "BH" PhoneNumberCountryCodeBd PhoneNumberCountryCode = "BD" PhoneNumberCountryCodeBb PhoneNumberCountryCode = "BB" PhoneNumberCountryCodeBy PhoneNumberCountryCode = "BY" PhoneNumberCountryCodeBe PhoneNumberCountryCode = "BE" PhoneNumberCountryCodeBz PhoneNumberCountryCode = "BZ" PhoneNumberCountryCodeBj PhoneNumberCountryCode = "BJ" PhoneNumberCountryCodeBm PhoneNumberCountryCode = "BM" PhoneNumberCountryCodeBt PhoneNumberCountryCode = "BT" PhoneNumberCountryCodeBo PhoneNumberCountryCode = "BO" PhoneNumberCountryCodeBa PhoneNumberCountryCode = "BA" PhoneNumberCountryCodeBw PhoneNumberCountryCode = "BW" PhoneNumberCountryCodeBr PhoneNumberCountryCode = "BR" PhoneNumberCountryCodeIo PhoneNumberCountryCode = "IO" PhoneNumberCountryCodeVg PhoneNumberCountryCode = "VG" PhoneNumberCountryCodeBn PhoneNumberCountryCode = "BN" PhoneNumberCountryCodeBg PhoneNumberCountryCode = "BG" PhoneNumberCountryCodeBf PhoneNumberCountryCode = "BF" PhoneNumberCountryCodeBi PhoneNumberCountryCode = "BI" PhoneNumberCountryCodeKh PhoneNumberCountryCode = "KH" PhoneNumberCountryCodeCm PhoneNumberCountryCode = "CM" PhoneNumberCountryCodeCa PhoneNumberCountryCode = "CA" PhoneNumberCountryCodeCv PhoneNumberCountryCode = "CV" PhoneNumberCountryCodeKy PhoneNumberCountryCode = "KY" PhoneNumberCountryCodeCf PhoneNumberCountryCode = "CF" PhoneNumberCountryCodeTd PhoneNumberCountryCode = "TD" PhoneNumberCountryCodeCl PhoneNumberCountryCode = "CL" PhoneNumberCountryCodeCn PhoneNumberCountryCode = "CN" PhoneNumberCountryCodeCx PhoneNumberCountryCode = "CX" PhoneNumberCountryCodeCc PhoneNumberCountryCode = "CC" PhoneNumberCountryCodeCo PhoneNumberCountryCode = "CO" PhoneNumberCountryCodeKm PhoneNumberCountryCode = "KM" PhoneNumberCountryCodeCk PhoneNumberCountryCode = "CK" PhoneNumberCountryCodeCr PhoneNumberCountryCode = "CR" PhoneNumberCountryCodeHr PhoneNumberCountryCode = "HR" PhoneNumberCountryCodeCu PhoneNumberCountryCode = "CU" PhoneNumberCountryCodeCw PhoneNumberCountryCode = "CW" PhoneNumberCountryCodeCy PhoneNumberCountryCode = "CY" PhoneNumberCountryCodeCz PhoneNumberCountryCode = "CZ" PhoneNumberCountryCodeCd PhoneNumberCountryCode = "CD" PhoneNumberCountryCodeDk PhoneNumberCountryCode = "DK" PhoneNumberCountryCodeDj PhoneNumberCountryCode = "DJ" PhoneNumberCountryCodeDm PhoneNumberCountryCode = "DM" PhoneNumberCountryCodeDo PhoneNumberCountryCode = "DO" PhoneNumberCountryCodeTl PhoneNumberCountryCode = "TL" PhoneNumberCountryCodeEc PhoneNumberCountryCode = "EC" PhoneNumberCountryCodeEg PhoneNumberCountryCode = "EG" PhoneNumberCountryCodeSv PhoneNumberCountryCode = "SV" PhoneNumberCountryCodeGq PhoneNumberCountryCode = "GQ" PhoneNumberCountryCodeEr PhoneNumberCountryCode = "ER" PhoneNumberCountryCodeEe PhoneNumberCountryCode = "EE" PhoneNumberCountryCodeEt PhoneNumberCountryCode = "ET" PhoneNumberCountryCodeFk PhoneNumberCountryCode = "FK" PhoneNumberCountryCodeFo PhoneNumberCountryCode = "FO" PhoneNumberCountryCodeFj PhoneNumberCountryCode = "FJ" PhoneNumberCountryCodeFi PhoneNumberCountryCode = "FI" PhoneNumberCountryCodeFr PhoneNumberCountryCode = "FR" PhoneNumberCountryCodePf PhoneNumberCountryCode = "PF" PhoneNumberCountryCodeGa PhoneNumberCountryCode = "GA" PhoneNumberCountryCodeGm PhoneNumberCountryCode = "GM" PhoneNumberCountryCodeGe PhoneNumberCountryCode = "GE" PhoneNumberCountryCodeDe PhoneNumberCountryCode = "DE" PhoneNumberCountryCodeGh PhoneNumberCountryCode = "GH" PhoneNumberCountryCodeGi PhoneNumberCountryCode = "GI" PhoneNumberCountryCodeGr PhoneNumberCountryCode = "GR" PhoneNumberCountryCodeGl PhoneNumberCountryCode = "GL" PhoneNumberCountryCodeGd PhoneNumberCountryCode = "GD" PhoneNumberCountryCodeGu PhoneNumberCountryCode = "GU" PhoneNumberCountryCodeGt PhoneNumberCountryCode = "GT" PhoneNumberCountryCodeGg PhoneNumberCountryCode = "GG" PhoneNumberCountryCodeGn PhoneNumberCountryCode = "GN" PhoneNumberCountryCodeGw PhoneNumberCountryCode = "GW" PhoneNumberCountryCodeGy PhoneNumberCountryCode = "GY" PhoneNumberCountryCodeHt PhoneNumberCountryCode = "HT" PhoneNumberCountryCodeHn PhoneNumberCountryCode = "HN" PhoneNumberCountryCodeHk PhoneNumberCountryCode = "HK" PhoneNumberCountryCodeHu PhoneNumberCountryCode = "HU" PhoneNumberCountryCodeIs PhoneNumberCountryCode = "IS" PhoneNumberCountryCodeIn PhoneNumberCountryCode = "IN" PhoneNumberCountryCodeId PhoneNumberCountryCode = "ID" PhoneNumberCountryCodeIr PhoneNumberCountryCode = "IR" PhoneNumberCountryCodeIq PhoneNumberCountryCode = "IQ" PhoneNumberCountryCodeIe PhoneNumberCountryCode = "IE" PhoneNumberCountryCodeIm PhoneNumberCountryCode = "IM" PhoneNumberCountryCodeIl PhoneNumberCountryCode = "IL" PhoneNumberCountryCodeIt PhoneNumberCountryCode = "IT" PhoneNumberCountryCodeCi PhoneNumberCountryCode = "CI" PhoneNumberCountryCodeJm PhoneNumberCountryCode = "JM" PhoneNumberCountryCodeJp PhoneNumberCountryCode = "JP" PhoneNumberCountryCodeJe PhoneNumberCountryCode = "JE" PhoneNumberCountryCodeJo PhoneNumberCountryCode = "JO" PhoneNumberCountryCodeKz PhoneNumberCountryCode = "KZ" PhoneNumberCountryCodeKe PhoneNumberCountryCode = "KE" PhoneNumberCountryCodeKi PhoneNumberCountryCode = "KI" PhoneNumberCountryCodeKw PhoneNumberCountryCode = "KW" PhoneNumberCountryCodeKg PhoneNumberCountryCode = "KG" PhoneNumberCountryCodeLa PhoneNumberCountryCode = "LA" PhoneNumberCountryCodeLv PhoneNumberCountryCode = "LV" PhoneNumberCountryCodeLb PhoneNumberCountryCode = "LB" PhoneNumberCountryCodeLs PhoneNumberCountryCode = "LS" PhoneNumberCountryCodeLr PhoneNumberCountryCode = "LR" PhoneNumberCountryCodeLy PhoneNumberCountryCode = "LY" PhoneNumberCountryCodeLi PhoneNumberCountryCode = "LI" PhoneNumberCountryCodeLt PhoneNumberCountryCode = "LT" PhoneNumberCountryCodeLu PhoneNumberCountryCode = "LU" PhoneNumberCountryCodeMo PhoneNumberCountryCode = "MO" PhoneNumberCountryCodeMk PhoneNumberCountryCode = "MK" PhoneNumberCountryCodeMg PhoneNumberCountryCode = "MG" PhoneNumberCountryCodeMw PhoneNumberCountryCode = "MW" PhoneNumberCountryCodeMy PhoneNumberCountryCode = "MY" PhoneNumberCountryCodeMv PhoneNumberCountryCode = "MV" PhoneNumberCountryCodeMl PhoneNumberCountryCode = "ML" PhoneNumberCountryCodeMt PhoneNumberCountryCode = "MT" PhoneNumberCountryCodeMh PhoneNumberCountryCode = "MH" PhoneNumberCountryCodeMr PhoneNumberCountryCode = "MR" PhoneNumberCountryCodeMu PhoneNumberCountryCode = "MU" PhoneNumberCountryCodeYt PhoneNumberCountryCode = "YT" PhoneNumberCountryCodeMx PhoneNumberCountryCode = "MX" PhoneNumberCountryCodeFm PhoneNumberCountryCode = "FM" PhoneNumberCountryCodeMd PhoneNumberCountryCode = "MD" PhoneNumberCountryCodeMc PhoneNumberCountryCode = "MC" PhoneNumberCountryCodeMn PhoneNumberCountryCode = "MN" PhoneNumberCountryCodeMe PhoneNumberCountryCode = "ME" PhoneNumberCountryCodeMs PhoneNumberCountryCode = "MS" PhoneNumberCountryCodeMa PhoneNumberCountryCode = "MA" PhoneNumberCountryCodeMz PhoneNumberCountryCode = "MZ" PhoneNumberCountryCodeMm PhoneNumberCountryCode = "MM" PhoneNumberCountryCodeNa PhoneNumberCountryCode = "NA" PhoneNumberCountryCodeNr PhoneNumberCountryCode = "NR" PhoneNumberCountryCodeNp PhoneNumberCountryCode = "NP" PhoneNumberCountryCodeNl PhoneNumberCountryCode = "NL" PhoneNumberCountryCodeAn PhoneNumberCountryCode = "AN" PhoneNumberCountryCodeNc PhoneNumberCountryCode = "NC" PhoneNumberCountryCodeNz PhoneNumberCountryCode = "NZ" PhoneNumberCountryCodeNi PhoneNumberCountryCode = "NI" PhoneNumberCountryCodeNe PhoneNumberCountryCode = "NE" PhoneNumberCountryCodeNg PhoneNumberCountryCode = "NG" PhoneNumberCountryCodeNu PhoneNumberCountryCode = "NU" PhoneNumberCountryCodeKp PhoneNumberCountryCode = "KP" PhoneNumberCountryCodeMp PhoneNumberCountryCode = "MP" PhoneNumberCountryCodeNo PhoneNumberCountryCode = "NO" PhoneNumberCountryCodeOm PhoneNumberCountryCode = "OM" PhoneNumberCountryCodePk PhoneNumberCountryCode = "PK" PhoneNumberCountryCodePw PhoneNumberCountryCode = "PW" PhoneNumberCountryCodePa PhoneNumberCountryCode = "PA" PhoneNumberCountryCodePg PhoneNumberCountryCode = "PG" PhoneNumberCountryCodePy PhoneNumberCountryCode = "PY" PhoneNumberCountryCodePe PhoneNumberCountryCode = "PE" PhoneNumberCountryCodePh PhoneNumberCountryCode = "PH" PhoneNumberCountryCodePn PhoneNumberCountryCode = "PN" PhoneNumberCountryCodePl PhoneNumberCountryCode = "PL" PhoneNumberCountryCodePt PhoneNumberCountryCode = "PT" PhoneNumberCountryCodePr PhoneNumberCountryCode = "PR" PhoneNumberCountryCodeQa PhoneNumberCountryCode = "QA" PhoneNumberCountryCodeCg PhoneNumberCountryCode = "CG" PhoneNumberCountryCodeRe PhoneNumberCountryCode = "RE" PhoneNumberCountryCodeRo PhoneNumberCountryCode = "RO" PhoneNumberCountryCodeRu PhoneNumberCountryCode = "RU" PhoneNumberCountryCodeRw PhoneNumberCountryCode = "RW" PhoneNumberCountryCodeBl PhoneNumberCountryCode = "BL" PhoneNumberCountryCodeSh PhoneNumberCountryCode = "SH" PhoneNumberCountryCodeKn PhoneNumberCountryCode = "KN" PhoneNumberCountryCodeLc PhoneNumberCountryCode = "LC" PhoneNumberCountryCodeMf PhoneNumberCountryCode = "MF" PhoneNumberCountryCodePm PhoneNumberCountryCode = "PM" PhoneNumberCountryCodeVc PhoneNumberCountryCode = "VC" PhoneNumberCountryCodeWs PhoneNumberCountryCode = "WS" PhoneNumberCountryCodeSm PhoneNumberCountryCode = "SM" PhoneNumberCountryCodeSt PhoneNumberCountryCode = "ST" PhoneNumberCountryCodeSa PhoneNumberCountryCode = "SA" PhoneNumberCountryCodeSn PhoneNumberCountryCode = "SN" PhoneNumberCountryCodeRs PhoneNumberCountryCode = "RS" PhoneNumberCountryCodeSc PhoneNumberCountryCode = "SC" PhoneNumberCountryCodeSl PhoneNumberCountryCode = "SL" PhoneNumberCountryCodeSg PhoneNumberCountryCode = "SG" PhoneNumberCountryCodeSx PhoneNumberCountryCode = "SX" PhoneNumberCountryCodeSk PhoneNumberCountryCode = "SK" PhoneNumberCountryCodeSi PhoneNumberCountryCode = "SI" PhoneNumberCountryCodeSb PhoneNumberCountryCode = "SB" PhoneNumberCountryCodeSo PhoneNumberCountryCode = "SO" PhoneNumberCountryCodeZa PhoneNumberCountryCode = "ZA" PhoneNumberCountryCodeKr PhoneNumberCountryCode = "KR" PhoneNumberCountryCodeEs PhoneNumberCountryCode = "ES" PhoneNumberCountryCodeLk PhoneNumberCountryCode = "LK" PhoneNumberCountryCodeSd PhoneNumberCountryCode = "SD" PhoneNumberCountryCodeSr PhoneNumberCountryCode = "SR" PhoneNumberCountryCodeSj PhoneNumberCountryCode = "SJ" PhoneNumberCountryCodeSz PhoneNumberCountryCode = "SZ" PhoneNumberCountryCodeSe PhoneNumberCountryCode = "SE" PhoneNumberCountryCodeCh PhoneNumberCountryCode = "CH" PhoneNumberCountryCodeSy PhoneNumberCountryCode = "SY" PhoneNumberCountryCodeTw PhoneNumberCountryCode = "TW" PhoneNumberCountryCodeTj PhoneNumberCountryCode = "TJ" PhoneNumberCountryCodeTz PhoneNumberCountryCode = "TZ" PhoneNumberCountryCodeTh PhoneNumberCountryCode = "TH" PhoneNumberCountryCodeTg PhoneNumberCountryCode = "TG" PhoneNumberCountryCodeTk PhoneNumberCountryCode = "TK" PhoneNumberCountryCodeTo PhoneNumberCountryCode = "TO" PhoneNumberCountryCodeTt PhoneNumberCountryCode = "TT" PhoneNumberCountryCodeTn PhoneNumberCountryCode = "TN" PhoneNumberCountryCodeTr PhoneNumberCountryCode = "TR" PhoneNumberCountryCodeTm PhoneNumberCountryCode = "TM" PhoneNumberCountryCodeTc PhoneNumberCountryCode = "TC" PhoneNumberCountryCodeTv PhoneNumberCountryCode = "TV" PhoneNumberCountryCodeVi PhoneNumberCountryCode = "VI" PhoneNumberCountryCodeUg PhoneNumberCountryCode = "UG" PhoneNumberCountryCodeUa PhoneNumberCountryCode = "UA" PhoneNumberCountryCodeAe PhoneNumberCountryCode = "AE" PhoneNumberCountryCodeGb PhoneNumberCountryCode = "GB" PhoneNumberCountryCodeUs PhoneNumberCountryCode = "US" PhoneNumberCountryCodeUy PhoneNumberCountryCode = "UY" PhoneNumberCountryCodeUz PhoneNumberCountryCode = "UZ" PhoneNumberCountryCodeVu PhoneNumberCountryCode = "VU" PhoneNumberCountryCodeVa PhoneNumberCountryCode = "VA" PhoneNumberCountryCodeVe PhoneNumberCountryCode = "VE" PhoneNumberCountryCodeVn PhoneNumberCountryCode = "VN" PhoneNumberCountryCodeWf PhoneNumberCountryCode = "WF" PhoneNumberCountryCodeEh PhoneNumberCountryCode = "EH" PhoneNumberCountryCodeYe PhoneNumberCountryCode = "YE" PhoneNumberCountryCodeZm PhoneNumberCountryCode = "ZM" PhoneNumberCountryCodeZw PhoneNumberCountryCode = "ZW" )
Enum values for PhoneNumberCountryCode
func (PhoneNumberCountryCode) MarshalValue ¶ added in v0.16.0
func (enum PhoneNumberCountryCode) MarshalValue() (string, error)
func (PhoneNumberCountryCode) MarshalValueBuf ¶ added in v0.16.0
func (enum PhoneNumberCountryCode) MarshalValueBuf(b []byte) ([]byte, error)
type PhoneNumberSummary ¶ added in v0.16.0
type PhoneNumberSummary struct { // The Amazon Resource Name (ARN) of the phone number. Arn *string `type:"string"` // The identifier of the phone number. Id *string `type:"string"` // The phone number. PhoneNumber *string `type:"string"` // The ISO country code. PhoneNumberCountryCode PhoneNumberCountryCode `type:"string" enum:"true"` // The type of phone number. PhoneNumberType PhoneNumberType `type:"string" enum:"true"` // contains filtered or unexported fields }
Contains summary information about a phone number for a contact center.
func (PhoneNumberSummary) MarshalFields ¶ added in v0.16.0
func (s PhoneNumberSummary) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PhoneNumberSummary) String ¶ added in v0.16.0
func (s PhoneNumberSummary) String() string
String returns the string representation
type PhoneNumberType ¶ added in v0.16.0
type PhoneNumberType string
const ( PhoneNumberTypeTollFree PhoneNumberType = "TOLL_FREE" PhoneNumberTypeDid PhoneNumberType = "DID" )
Enum values for PhoneNumberType
func (PhoneNumberType) MarshalValue ¶ added in v0.16.0
func (enum PhoneNumberType) MarshalValue() (string, error)
func (PhoneNumberType) MarshalValueBuf ¶ added in v0.16.0
func (enum PhoneNumberType) MarshalValueBuf(b []byte) ([]byte, error)
type PhoneType ¶ added in v0.5.0
type PhoneType string
Enum values for PhoneType
func (PhoneType) MarshalValue ¶ added in v0.5.0
type QueueReference ¶ added in v0.5.0
type QueueReference struct { // The Amazon Resource Name (ARN) of the queue. Arn *string `type:"string"` // The identifier of the queue. Id *string `type:"string"` // contains filtered or unexported fields }
Contains information about a 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 QueueSummary ¶ added in v0.16.0
type QueueSummary struct { // The Amazon Resource Name (ARN) of the queue. Arn *string `type:"string"` // The identifier of the queue. Id *string `type:"string"` // The name of the queue. Name *string `min:"1" type:"string"` // The type of queue. QueueType QueueType `type:"string" enum:"true"` // contains filtered or unexported fields }
Contains summary information about a queue.
func (QueueSummary) MarshalFields ¶ added in v0.16.0
func (s QueueSummary) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (QueueSummary) String ¶ added in v0.16.0
func (s QueueSummary) String() string
String returns the string representation
type QueueType ¶ added in v0.16.0
type QueueType string
Enum values for QueueType
func (QueueType) MarshalValue ¶ added in v0.16.0
type RoutingProfileSummary ¶ added in v0.5.0
type RoutingProfileSummary struct { // The Amazon Resource Name (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 }
Contains summary information about a routing profile.
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 Amazon Resource Name (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 }
Contains information about a security profile.
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 StartChatContactInput ¶ added in v0.18.0
type StartChatContactInput struct { // A custom key-value pair using an attribute map. The attributes are standard // Amazon Connect attributes, and can be accessed in contact flows just like // any other contact attributes. // // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. // Attribute keys can include only alphanumeric, dash, and underscore characters. Attributes map[string]string `type:"map"` // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string `type:"string" idempotencyToken:"true"` // The identifier of the contact flow for the chat. // // ContactFlowId is a required field ContactFlowId *string `type:"string" required:"true"` // The initial message to be sent to the newly created chat. InitialMessage *ChatMessage `type:"structure"` // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `min:"1" type:"string" required:"true"` // Information identifying the participant. // // ParticipantDetails is a required field ParticipantDetails *ParticipantDetails `type:"structure" required:"true"` // contains filtered or unexported fields }
func (StartChatContactInput) MarshalFields ¶ added in v0.18.0
func (s StartChatContactInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (StartChatContactInput) String ¶ added in v0.18.0
func (s StartChatContactInput) String() string
String returns the string representation
func (*StartChatContactInput) Validate ¶ added in v0.18.0
func (s *StartChatContactInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartChatContactOutput ¶ added in v0.18.0
type StartChatContactOutput struct { // The identifier of this contact within the Amazon Connect instance. ContactId *string `min:"1" type:"string"` // The identifier for a chat participant. The participantId for a chat participant // is the same throughout the chat lifecycle. ParticipantId *string `min:"1" type:"string"` // The token used by the chat participant to call CreateParticipantConnection // (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html). // The participant token is valid for the lifetime of a chat participant. ParticipantToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (StartChatContactOutput) MarshalFields ¶ added in v0.18.0
func (s StartChatContactOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (StartChatContactOutput) String ¶ added in v0.18.0
func (s StartChatContactOutput) String() string
String returns the string representation
type StartChatContactRequest ¶ added in v0.18.0
type StartChatContactRequest struct { *aws.Request Input *StartChatContactInput Copy func(*StartChatContactInput) StartChatContactRequest }
StartChatContactRequest is the request type for the StartChatContact API operation.
func (StartChatContactRequest) Send ¶ added in v0.18.0
func (r StartChatContactRequest) Send(ctx context.Context) (*StartChatContactResponse, error)
Send marshals and sends the StartChatContact API request.
type StartChatContactResponse ¶ added in v0.18.0
type StartChatContactResponse struct { *StartChatContactOutput // contains filtered or unexported fields }
StartChatContactResponse is the response type for the StartChatContact API operation.
func (*StartChatContactResponse) SDKResponseMetdata ¶ added in v0.18.0
func (r *StartChatContactResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StartChatContact request.
type StartOutboundVoiceContactInput ¶
type StartOutboundVoiceContactInput struct { // A custom key-value pair using an attribute map. The attributes are standard // Amazon Connect attributes, and can be accessed in contact flows just like // any other contact attributes. // // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. // Attribute keys can include only alphanumeric, dash, and underscore characters. Attributes map[string]string `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 of the contact flow for the outbound call. // // 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 of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `min:"1" type:"string" required:"true"` // The queue for the call. If you specify a queue, the phone displayed for caller // ID is the phone number specified in the queue. If you do not specify a queue, // the queue defined in the contact flow is used. If you do not specify a queue, // you must specify a source phone number. QueueId *string `type:"string"` // The phone number associated with the Amazon Connect instance, in E.164 format. // If you do not specify a source phone number, you must specify a queue. SourcePhoneNumber *string `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 identifier of this contact within the 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
type StopContactInput ¶
type StopContactInput struct { // The ID of the contact. // // ContactId is a required field ContactId *string `min:"1" type:"string" required:"true"` // The identifier of the Amazon Connect instance. // // 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 TagResourceInput ¶ added in v0.17.0
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} // }. // // Tags is a required field Tags map[string]string `locationName:"tags" min:"1" type:"map" required:"true"` // contains filtered or unexported fields }
func (TagResourceInput) MarshalFields ¶ added in v0.17.0
func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceInput) String ¶ added in v0.17.0
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶ added in v0.17.0
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶ added in v0.17.0
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) MarshalFields ¶ added in v0.17.0
func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceOutput) String ¶ added in v0.17.0
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶ added in v0.17.0
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶ added in v0.17.0
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶ added in v0.17.0
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶ added in v0.17.0
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type Threshold ¶ added in v0.5.0
type Threshold struct { // The type of comparison. Only "less than" (LT) comparisons are supported. Comparison Comparison `type:"string" enum:"true"` // The threshold value to compare. ThresholdValue *float64 `type:"double"` // contains filtered or unexported fields }
Contains information about the threshold for 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.
type Unit ¶ added in v0.5.0
type Unit string
Enum values for Unit
func (Unit) MarshalValue ¶ added in v0.5.0
type UntagResourceInput ¶ added in v0.17.0
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // The tag keys. // // TagKeys is a required field TagKeys []string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) MarshalFields ¶ added in v0.17.0
func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceInput) String ¶ added in v0.17.0
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶ added in v0.17.0
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶ added in v0.17.0
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) MarshalFields ¶ added in v0.17.0
func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceOutput) String ¶ added in v0.17.0
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶ added in v0.17.0
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶ added in v0.17.0
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶ added in v0.17.0
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶ added in v0.17.0
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
type UpdateContactAttributesInput ¶ added in v0.5.0
type UpdateContactAttributesInput struct { // The Amazon Connect attributes. These attributes can be accessed in contact // flows just like any other contact attributes. // // You can have up to 32,768 UTF-8 bytes across all attributes for a contact. // Attribute keys can include only alphanumeric, dash, and underscore characters. // // Attributes is a required field Attributes map[string]string `type:"map" required:"true"` // The identifier of the contact. This is the identifier of 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 of the Amazon Connect instance. // // 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 of the hierarchy group. HierarchyGroupId *string `type:"string"` // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifier of the user account. // // 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 { // The identity information for the user. // // IdentityInfo is a required field IdentityInfo *UserIdentityInfo `type:"structure" required:"true"` // The identifier of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifier of the user account. // // 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 of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // Information about phone configuration settings for the user. // // PhoneConfig is a required field PhoneConfig *UserPhoneConfig `type:"structure" required:"true"` // The identifier of the user account. // // 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 of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifier of the routing profile for the user. // // RoutingProfileId is a required field RoutingProfileId *string `type:"string" required:"true"` // The identifier of the user account. // // 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 of the Amazon Connect instance. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifiers of the security profiles for the user. // // SecurityProfileIds is a required field SecurityProfileIds []string `min:"1" type:"list" required:"true"` // The identifier of the user account. // // 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 Amazon Resource Name (ARN) of the user account. Arn *string `type:"string"` // The identifier of the user account in the directory used for identity management. DirectoryUserId *string `type:"string"` // The identifier of the hierarchy group for the user. HierarchyGroupId *string `type:"string"` // The identifier of the user account. Id *string `type:"string"` // Information about the user identity. IdentityInfo *UserIdentityInfo `type:"structure"` // Information about the phone configuration for the user. PhoneConfig *UserPhoneConfig `type:"structure"` // The identifier of the routing profile for the user. RoutingProfileId *string `type:"string"` // The identifiers of the security profiles for the user. SecurityProfileIds []string `min:"1" type:"list"` // The tags. Tags map[string]string `min:"1" type:"map"` // The user name assigned to the user account. Username *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains information about a user account for a Amazon Connect instance.
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.
type UserIdentityInfo ¶ added in v0.5.0
type UserIdentityInfo struct { // The email address. If you are using SAML for identity management and include // this parameter, an error is returned. Email *string `type:"string"` // The first name. This is required if you are using Amazon Connect or SAML // for identity management. FirstName *string `min:"1" type:"string"` // The last name. 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 }
Contains information about the identity of a user.
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. AfterContactWorkTimeLimit *int64 `type:"integer"` // The Auto accept setting. AutoAccept *bool `type:"boolean"` // The phone number for the user's desk phone. DeskPhoneNumber *string `type:"string"` // The phone type. // // PhoneType is a required field PhoneType PhoneType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Contains information about the phone configuration settings for a user.
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 Amazon Resource Name (ARN) of the user account. Arn *string `type:"string"` // The identifier of the user account. Id *string `type:"string"` // The Amazon Connect user name of the user account. Username *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains summary information about a user.
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 ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_CreateUser.go
- api_op_DeleteUser.go
- api_op_DescribeUser.go
- api_op_DescribeUserHierarchyGroup.go
- api_op_DescribeUserHierarchyStructure.go
- api_op_GetContactAttributes.go
- api_op_GetCurrentMetricData.go
- api_op_GetFederationToken.go
- api_op_GetMetricData.go
- api_op_ListContactFlows.go
- api_op_ListHoursOfOperations.go
- api_op_ListPhoneNumbers.go
- api_op_ListQueues.go
- api_op_ListRoutingProfiles.go
- api_op_ListSecurityProfiles.go
- api_op_ListTagsForResource.go
- api_op_ListUserHierarchyGroups.go
- api_op_ListUsers.go
- api_op_StartChatContact.go
- api_op_StartOutboundVoiceContact.go
- api_op_StopContact.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateContactAttributes.go
- api_op_UpdateUserHierarchy.go
- api_op_UpdateUserIdentityInfo.go
- api_op_UpdateUserPhoneConfig.go
- api_op_UpdateUserRoutingProfile.go
- api_op_UpdateUserSecurityProfiles.go
- api_types.go
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. |