Documentation ¶
Overview ¶
Package connect provides the client and types for making API requests to Amazon Connect Service.
The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.
See https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08 for more information on this service.
See connect package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/connect/
Using the Client ¶
To contact Amazon Connect Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon Connect Service client Connect for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/connect/#New
Index ¶
- Constants
- type Connect
- func (c *Connect) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)
- func (c *Connect) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)
- func (c *Connect) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)
- func (c *Connect) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)
- func (c *Connect) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)
- func (c *Connect) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)
- func (c *Connect) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)
- func (c *Connect) DescribeUserHierarchyGroup(input *DescribeUserHierarchyGroupInput) (*DescribeUserHierarchyGroupOutput, error)
- func (c *Connect) DescribeUserHierarchyGroupRequest(input *DescribeUserHierarchyGroupInput) (req *request.Request, output *DescribeUserHierarchyGroupOutput)
- func (c *Connect) DescribeUserHierarchyGroupWithContext(ctx aws.Context, input *DescribeUserHierarchyGroupInput, ...) (*DescribeUserHierarchyGroupOutput, error)
- func (c *Connect) DescribeUserHierarchyStructure(input *DescribeUserHierarchyStructureInput) (*DescribeUserHierarchyStructureOutput, error)
- func (c *Connect) DescribeUserHierarchyStructureRequest(input *DescribeUserHierarchyStructureInput) (req *request.Request, output *DescribeUserHierarchyStructureOutput)
- func (c *Connect) DescribeUserHierarchyStructureWithContext(ctx aws.Context, input *DescribeUserHierarchyStructureInput, ...) (*DescribeUserHierarchyStructureOutput, error)
- func (c *Connect) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)
- func (c *Connect) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)
- func (c *Connect) GetFederationToken(input *GetFederationTokenInput) (*GetFederationTokenOutput, error)
- func (c *Connect) GetFederationTokenRequest(input *GetFederationTokenInput) (req *request.Request, output *GetFederationTokenOutput)
- func (c *Connect) GetFederationTokenWithContext(ctx aws.Context, input *GetFederationTokenInput, opts ...request.Option) (*GetFederationTokenOutput, error)
- func (c *Connect) ListRoutingProfiles(input *ListRoutingProfilesInput) (*ListRoutingProfilesOutput, error)
- func (c *Connect) ListRoutingProfilesRequest(input *ListRoutingProfilesInput) (req *request.Request, output *ListRoutingProfilesOutput)
- func (c *Connect) ListRoutingProfilesWithContext(ctx aws.Context, input *ListRoutingProfilesInput, opts ...request.Option) (*ListRoutingProfilesOutput, error)
- func (c *Connect) ListSecurityProfiles(input *ListSecurityProfilesInput) (*ListSecurityProfilesOutput, error)
- func (c *Connect) ListSecurityProfilesRequest(input *ListSecurityProfilesInput) (req *request.Request, output *ListSecurityProfilesOutput)
- func (c *Connect) ListSecurityProfilesWithContext(ctx aws.Context, input *ListSecurityProfilesInput, opts ...request.Option) (*ListSecurityProfilesOutput, error)
- func (c *Connect) ListUserHierarchyGroups(input *ListUserHierarchyGroupsInput) (*ListUserHierarchyGroupsOutput, error)
- func (c *Connect) ListUserHierarchyGroupsRequest(input *ListUserHierarchyGroupsInput) (req *request.Request, output *ListUserHierarchyGroupsOutput)
- func (c *Connect) ListUserHierarchyGroupsWithContext(ctx aws.Context, input *ListUserHierarchyGroupsInput, opts ...request.Option) (*ListUserHierarchyGroupsOutput, error)
- func (c *Connect) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)
- func (c *Connect) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)
- func (c *Connect) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)
- func (c *Connect) StartOutboundVoiceContact(input *StartOutboundVoiceContactInput) (*StartOutboundVoiceContactOutput, error)
- func (c *Connect) StartOutboundVoiceContactRequest(input *StartOutboundVoiceContactInput) (req *request.Request, output *StartOutboundVoiceContactOutput)
- func (c *Connect) StartOutboundVoiceContactWithContext(ctx aws.Context, input *StartOutboundVoiceContactInput, opts ...request.Option) (*StartOutboundVoiceContactOutput, error)
- func (c *Connect) StopContact(input *StopContactInput) (*StopContactOutput, error)
- func (c *Connect) StopContactRequest(input *StopContactInput) (req *request.Request, output *StopContactOutput)
- func (c *Connect) StopContactWithContext(ctx aws.Context, input *StopContactInput, opts ...request.Option) (*StopContactOutput, error)
- func (c *Connect) UpdateUserHierarchy(input *UpdateUserHierarchyInput) (*UpdateUserHierarchyOutput, error)
- func (c *Connect) UpdateUserHierarchyRequest(input *UpdateUserHierarchyInput) (req *request.Request, output *UpdateUserHierarchyOutput)
- func (c *Connect) UpdateUserHierarchyWithContext(ctx aws.Context, input *UpdateUserHierarchyInput, opts ...request.Option) (*UpdateUserHierarchyOutput, error)
- func (c *Connect) UpdateUserIdentityInfo(input *UpdateUserIdentityInfoInput) (*UpdateUserIdentityInfoOutput, error)
- func (c *Connect) UpdateUserIdentityInfoRequest(input *UpdateUserIdentityInfoInput) (req *request.Request, output *UpdateUserIdentityInfoOutput)
- func (c *Connect) UpdateUserIdentityInfoWithContext(ctx aws.Context, input *UpdateUserIdentityInfoInput, opts ...request.Option) (*UpdateUserIdentityInfoOutput, error)
- func (c *Connect) UpdateUserPhoneConfig(input *UpdateUserPhoneConfigInput) (*UpdateUserPhoneConfigOutput, error)
- func (c *Connect) UpdateUserPhoneConfigRequest(input *UpdateUserPhoneConfigInput) (req *request.Request, output *UpdateUserPhoneConfigOutput)
- func (c *Connect) UpdateUserPhoneConfigWithContext(ctx aws.Context, input *UpdateUserPhoneConfigInput, opts ...request.Option) (*UpdateUserPhoneConfigOutput, error)
- func (c *Connect) UpdateUserRoutingProfile(input *UpdateUserRoutingProfileInput) (*UpdateUserRoutingProfileOutput, error)
- func (c *Connect) UpdateUserRoutingProfileRequest(input *UpdateUserRoutingProfileInput) (req *request.Request, output *UpdateUserRoutingProfileOutput)
- func (c *Connect) UpdateUserRoutingProfileWithContext(ctx aws.Context, input *UpdateUserRoutingProfileInput, opts ...request.Option) (*UpdateUserRoutingProfileOutput, error)
- func (c *Connect) UpdateUserSecurityProfiles(input *UpdateUserSecurityProfilesInput) (*UpdateUserSecurityProfilesOutput, error)
- func (c *Connect) UpdateUserSecurityProfilesRequest(input *UpdateUserSecurityProfilesInput) (req *request.Request, output *UpdateUserSecurityProfilesOutput)
- func (c *Connect) UpdateUserSecurityProfilesWithContext(ctx aws.Context, input *UpdateUserSecurityProfilesInput, ...) (*UpdateUserSecurityProfilesOutput, error)
- type CreateUserInput
- func (s CreateUserInput) GoString() string
- func (s *CreateUserInput) SetDirectoryUserId(v string) *CreateUserInput
- func (s *CreateUserInput) SetHierarchyGroupId(v string) *CreateUserInput
- func (s *CreateUserInput) SetIdentityInfo(v *UserIdentityInfo) *CreateUserInput
- func (s *CreateUserInput) SetInstanceId(v string) *CreateUserInput
- func (s *CreateUserInput) SetPassword(v string) *CreateUserInput
- func (s *CreateUserInput) SetPhoneConfig(v *UserPhoneConfig) *CreateUserInput
- func (s *CreateUserInput) SetRoutingProfileId(v string) *CreateUserInput
- func (s *CreateUserInput) SetSecurityProfileIds(v []*string) *CreateUserInput
- func (s *CreateUserInput) SetUsername(v string) *CreateUserInput
- func (s CreateUserInput) String() string
- func (s *CreateUserInput) Validate() error
- type CreateUserOutput
- type Credentials
- func (s Credentials) GoString() string
- func (s *Credentials) SetAccessToken(v string) *Credentials
- func (s *Credentials) SetAccessTokenExpiration(v time.Time) *Credentials
- func (s *Credentials) SetRefreshToken(v string) *Credentials
- func (s *Credentials) SetRefreshTokenExpiration(v time.Time) *Credentials
- func (s Credentials) String() string
- type DeleteUserInput
- type DeleteUserOutput
- type DescribeUserHierarchyGroupInput
- func (s DescribeUserHierarchyGroupInput) GoString() string
- func (s *DescribeUserHierarchyGroupInput) SetHierarchyGroupId(v string) *DescribeUserHierarchyGroupInput
- func (s *DescribeUserHierarchyGroupInput) SetInstanceId(v string) *DescribeUserHierarchyGroupInput
- func (s DescribeUserHierarchyGroupInput) String() string
- func (s *DescribeUserHierarchyGroupInput) Validate() error
- type DescribeUserHierarchyGroupOutput
- type DescribeUserHierarchyStructureInput
- type DescribeUserHierarchyStructureOutput
- type DescribeUserInput
- type DescribeUserOutput
- type GetFederationTokenInput
- type GetFederationTokenOutput
- type HierarchyGroup
- func (s HierarchyGroup) GoString() string
- func (s *HierarchyGroup) SetArn(v string) *HierarchyGroup
- func (s *HierarchyGroup) SetHierarchyPath(v *HierarchyPath) *HierarchyGroup
- func (s *HierarchyGroup) SetId(v string) *HierarchyGroup
- func (s *HierarchyGroup) SetLevelId(v string) *HierarchyGroup
- func (s *HierarchyGroup) SetName(v string) *HierarchyGroup
- func (s HierarchyGroup) String() string
- type HierarchyGroupSummary
- func (s HierarchyGroupSummary) GoString() string
- func (s *HierarchyGroupSummary) SetArn(v string) *HierarchyGroupSummary
- func (s *HierarchyGroupSummary) SetId(v string) *HierarchyGroupSummary
- func (s *HierarchyGroupSummary) SetName(v string) *HierarchyGroupSummary
- func (s HierarchyGroupSummary) String() string
- type HierarchyLevel
- type HierarchyPath
- func (s HierarchyPath) GoString() string
- func (s *HierarchyPath) SetLevelFive(v *HierarchyGroupSummary) *HierarchyPath
- func (s *HierarchyPath) SetLevelFour(v *HierarchyGroupSummary) *HierarchyPath
- func (s *HierarchyPath) SetLevelOne(v *HierarchyGroupSummary) *HierarchyPath
- func (s *HierarchyPath) SetLevelThree(v *HierarchyGroupSummary) *HierarchyPath
- func (s *HierarchyPath) SetLevelTwo(v *HierarchyGroupSummary) *HierarchyPath
- func (s HierarchyPath) String() string
- type HierarchyStructure
- func (s HierarchyStructure) GoString() string
- func (s *HierarchyStructure) SetLevelFive(v *HierarchyLevel) *HierarchyStructure
- func (s *HierarchyStructure) SetLevelFour(v *HierarchyLevel) *HierarchyStructure
- func (s *HierarchyStructure) SetLevelOne(v *HierarchyLevel) *HierarchyStructure
- func (s *HierarchyStructure) SetLevelThree(v *HierarchyLevel) *HierarchyStructure
- func (s *HierarchyStructure) SetLevelTwo(v *HierarchyLevel) *HierarchyStructure
- func (s HierarchyStructure) String() string
- type ListRoutingProfilesInput
- func (s ListRoutingProfilesInput) GoString() string
- func (s *ListRoutingProfilesInput) SetInstanceId(v string) *ListRoutingProfilesInput
- func (s *ListRoutingProfilesInput) SetMaxResults(v int64) *ListRoutingProfilesInput
- func (s *ListRoutingProfilesInput) SetNextToken(v string) *ListRoutingProfilesInput
- func (s ListRoutingProfilesInput) String() string
- func (s *ListRoutingProfilesInput) Validate() error
- type ListRoutingProfilesOutput
- func (s ListRoutingProfilesOutput) GoString() string
- func (s *ListRoutingProfilesOutput) SetNextToken(v string) *ListRoutingProfilesOutput
- func (s *ListRoutingProfilesOutput) SetRoutingProfileSummaryList(v []*RoutingProfileSummary) *ListRoutingProfilesOutput
- func (s ListRoutingProfilesOutput) String() string
- type ListSecurityProfilesInput
- func (s ListSecurityProfilesInput) GoString() string
- func (s *ListSecurityProfilesInput) SetInstanceId(v string) *ListSecurityProfilesInput
- func (s *ListSecurityProfilesInput) SetMaxResults(v int64) *ListSecurityProfilesInput
- func (s *ListSecurityProfilesInput) SetNextToken(v string) *ListSecurityProfilesInput
- func (s ListSecurityProfilesInput) String() string
- func (s *ListSecurityProfilesInput) Validate() error
- type ListSecurityProfilesOutput
- func (s ListSecurityProfilesOutput) GoString() string
- func (s *ListSecurityProfilesOutput) SetNextToken(v string) *ListSecurityProfilesOutput
- func (s *ListSecurityProfilesOutput) SetSecurityProfileSummaryList(v []*SecurityProfileSummary) *ListSecurityProfilesOutput
- func (s ListSecurityProfilesOutput) String() string
- type ListUserHierarchyGroupsInput
- func (s ListUserHierarchyGroupsInput) GoString() string
- func (s *ListUserHierarchyGroupsInput) SetInstanceId(v string) *ListUserHierarchyGroupsInput
- func (s *ListUserHierarchyGroupsInput) SetMaxResults(v int64) *ListUserHierarchyGroupsInput
- func (s *ListUserHierarchyGroupsInput) SetNextToken(v string) *ListUserHierarchyGroupsInput
- func (s ListUserHierarchyGroupsInput) String() string
- func (s *ListUserHierarchyGroupsInput) Validate() error
- type ListUserHierarchyGroupsOutput
- func (s ListUserHierarchyGroupsOutput) GoString() string
- func (s *ListUserHierarchyGroupsOutput) SetNextToken(v string) *ListUserHierarchyGroupsOutput
- func (s *ListUserHierarchyGroupsOutput) SetUserHierarchyGroupSummaryList(v []*HierarchyGroupSummary) *ListUserHierarchyGroupsOutput
- func (s ListUserHierarchyGroupsOutput) String() string
- type ListUsersInput
- func (s ListUsersInput) GoString() string
- func (s *ListUsersInput) SetInstanceId(v string) *ListUsersInput
- func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput
- func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput
- func (s ListUsersInput) String() string
- func (s *ListUsersInput) Validate() error
- type ListUsersOutput
- type RoutingProfileSummary
- func (s RoutingProfileSummary) GoString() string
- func (s *RoutingProfileSummary) SetArn(v string) *RoutingProfileSummary
- func (s *RoutingProfileSummary) SetId(v string) *RoutingProfileSummary
- func (s *RoutingProfileSummary) SetName(v string) *RoutingProfileSummary
- func (s RoutingProfileSummary) String() string
- type SecurityProfileSummary
- func (s SecurityProfileSummary) GoString() string
- func (s *SecurityProfileSummary) SetArn(v string) *SecurityProfileSummary
- func (s *SecurityProfileSummary) SetId(v string) *SecurityProfileSummary
- func (s *SecurityProfileSummary) SetName(v string) *SecurityProfileSummary
- func (s SecurityProfileSummary) String() string
- type StartOutboundVoiceContactInput
- func (s StartOutboundVoiceContactInput) GoString() string
- func (s *StartOutboundVoiceContactInput) SetAttributes(v map[string]*string) *StartOutboundVoiceContactInput
- func (s *StartOutboundVoiceContactInput) SetClientToken(v string) *StartOutboundVoiceContactInput
- func (s *StartOutboundVoiceContactInput) SetContactFlowId(v string) *StartOutboundVoiceContactInput
- func (s *StartOutboundVoiceContactInput) SetDestinationPhoneNumber(v string) *StartOutboundVoiceContactInput
- func (s *StartOutboundVoiceContactInput) SetInstanceId(v string) *StartOutboundVoiceContactInput
- func (s *StartOutboundVoiceContactInput) SetQueueId(v string) *StartOutboundVoiceContactInput
- func (s *StartOutboundVoiceContactInput) SetSourcePhoneNumber(v string) *StartOutboundVoiceContactInput
- func (s StartOutboundVoiceContactInput) String() string
- func (s *StartOutboundVoiceContactInput) Validate() error
- type StartOutboundVoiceContactOutput
- type StopContactInput
- type StopContactOutput
- type UpdateUserHierarchyInput
- func (s UpdateUserHierarchyInput) GoString() string
- func (s *UpdateUserHierarchyInput) SetHierarchyGroupId(v string) *UpdateUserHierarchyInput
- func (s *UpdateUserHierarchyInput) SetInstanceId(v string) *UpdateUserHierarchyInput
- func (s *UpdateUserHierarchyInput) SetUserId(v string) *UpdateUserHierarchyInput
- func (s UpdateUserHierarchyInput) String() string
- func (s *UpdateUserHierarchyInput) Validate() error
- type UpdateUserHierarchyOutput
- type UpdateUserIdentityInfoInput
- func (s UpdateUserIdentityInfoInput) GoString() string
- func (s *UpdateUserIdentityInfoInput) SetIdentityInfo(v *UserIdentityInfo) *UpdateUserIdentityInfoInput
- func (s *UpdateUserIdentityInfoInput) SetInstanceId(v string) *UpdateUserIdentityInfoInput
- func (s *UpdateUserIdentityInfoInput) SetUserId(v string) *UpdateUserIdentityInfoInput
- func (s UpdateUserIdentityInfoInput) String() string
- func (s *UpdateUserIdentityInfoInput) Validate() error
- type UpdateUserIdentityInfoOutput
- type UpdateUserPhoneConfigInput
- func (s UpdateUserPhoneConfigInput) GoString() string
- func (s *UpdateUserPhoneConfigInput) SetInstanceId(v string) *UpdateUserPhoneConfigInput
- func (s *UpdateUserPhoneConfigInput) SetPhoneConfig(v *UserPhoneConfig) *UpdateUserPhoneConfigInput
- func (s *UpdateUserPhoneConfigInput) SetUserId(v string) *UpdateUserPhoneConfigInput
- func (s UpdateUserPhoneConfigInput) String() string
- func (s *UpdateUserPhoneConfigInput) Validate() error
- type UpdateUserPhoneConfigOutput
- type UpdateUserRoutingProfileInput
- func (s UpdateUserRoutingProfileInput) GoString() string
- func (s *UpdateUserRoutingProfileInput) SetInstanceId(v string) *UpdateUserRoutingProfileInput
- func (s *UpdateUserRoutingProfileInput) SetRoutingProfileId(v string) *UpdateUserRoutingProfileInput
- func (s *UpdateUserRoutingProfileInput) SetUserId(v string) *UpdateUserRoutingProfileInput
- func (s UpdateUserRoutingProfileInput) String() string
- func (s *UpdateUserRoutingProfileInput) Validate() error
- type UpdateUserRoutingProfileOutput
- type UpdateUserSecurityProfilesInput
- func (s UpdateUserSecurityProfilesInput) GoString() string
- func (s *UpdateUserSecurityProfilesInput) SetInstanceId(v string) *UpdateUserSecurityProfilesInput
- func (s *UpdateUserSecurityProfilesInput) SetSecurityProfileIds(v []*string) *UpdateUserSecurityProfilesInput
- func (s *UpdateUserSecurityProfilesInput) SetUserId(v string) *UpdateUserSecurityProfilesInput
- func (s UpdateUserSecurityProfilesInput) String() string
- func (s *UpdateUserSecurityProfilesInput) Validate() error
- type UpdateUserSecurityProfilesOutput
- type User
- func (s User) GoString() string
- func (s *User) SetArn(v string) *User
- func (s *User) SetDirectoryUserId(v string) *User
- func (s *User) SetHierarchyGroupId(v string) *User
- func (s *User) SetId(v string) *User
- func (s *User) SetIdentityInfo(v *UserIdentityInfo) *User
- func (s *User) SetPhoneConfig(v *UserPhoneConfig) *User
- func (s *User) SetRoutingProfileId(v string) *User
- func (s *User) SetSecurityProfileIds(v []*string) *User
- func (s *User) SetUsername(v string) *User
- func (s User) String() string
- type UserIdentityInfo
- func (s UserIdentityInfo) GoString() string
- func (s *UserIdentityInfo) SetEmail(v string) *UserIdentityInfo
- func (s *UserIdentityInfo) SetFirstName(v string) *UserIdentityInfo
- func (s *UserIdentityInfo) SetLastName(v string) *UserIdentityInfo
- func (s UserIdentityInfo) String() string
- func (s *UserIdentityInfo) Validate() error
- type UserPhoneConfig
- func (s UserPhoneConfig) GoString() string
- func (s *UserPhoneConfig) SetAfterContactWorkTimeLimit(v int64) *UserPhoneConfig
- func (s *UserPhoneConfig) SetAutoAccept(v bool) *UserPhoneConfig
- func (s *UserPhoneConfig) SetDeskPhoneNumber(v string) *UserPhoneConfig
- func (s *UserPhoneConfig) SetPhoneType(v string) *UserPhoneConfig
- func (s UserPhoneConfig) String() string
- func (s *UserPhoneConfig) Validate() error
- type UserSummary
Constants ¶
const ( // PhoneTypeSoftPhone is a PhoneType enum value PhoneTypeSoftPhone = "SOFT_PHONE" // PhoneTypeDeskPhone is a PhoneType enum value PhoneTypeDeskPhone = "DESK_PHONE" )
const ( // ErrCodeContactNotFoundException for service response error code // "ContactNotFoundException". // // The contact with the specified ID is not active or does not exist. ErrCodeContactNotFoundException = "ContactNotFoundException" // ErrCodeDestinationNotAllowedException for service response error code // "DestinationNotAllowedException". // // Outbound calls to the destination number are not allowed. ErrCodeDestinationNotAllowedException = "DestinationNotAllowedException" // ErrCodeDuplicateResourceException for service response error code // "DuplicateResourceException". // // A resource with that name already exisits. ErrCodeDuplicateResourceException = "DuplicateResourceException" // ErrCodeInternalServiceException for service response error code // "InternalServiceException". // // Request processing failed due to an error or failure with the service. ErrCodeInternalServiceException = "InternalServiceException" // ErrCodeInvalidParameterException for service response error code // "InvalidParameterException". // // One or more of the parameters provided to the operation are not valid. ErrCodeInvalidParameterException = "InvalidParameterException" // ErrCodeInvalidRequestException for service response error code // "InvalidRequestException". // // The request is not valid. ErrCodeInvalidRequestException = "InvalidRequestException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // The limit exceeded the maximum allowed active calls in a queue. 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" )
const ( ServiceName = "connect" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "Connect" // ServiceID is a unique identifer of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Connect ¶
Connect provides the API operation methods for making requests to Amazon Connect Service. See this package's package overview docs for details on the service.
Connect methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Connect
New creates a new instance of the Connect client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a Connect client from just a session. svc := connect.New(mySession) // Create a Connect client with additional configuration svc := connect.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*Connect) CreateUser ¶ added in v1.15.2
func (c *Connect) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)
CreateUser API operation for Amazon Connect Service.
Creates a new user account in your Amazon Connect instance.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation CreateUser for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeLimitExceededException "LimitExceededException" The limit exceeded the maximum allowed active calls in a queue.
ErrCodeDuplicateResourceException "DuplicateResourceException" A resource with that name already exisits.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser
func (*Connect) CreateUserRequest ¶ added in v1.15.2
func (c *Connect) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)
CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateUser for more information on using the CreateUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateUserRequest method. req, resp := client.CreateUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser
func (*Connect) CreateUserWithContext ¶ added in v1.15.2
func (c *Connect) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)
CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.
See CreateUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) DeleteUser ¶ added in v1.15.2
func (c *Connect) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)
DeleteUser API operation for Amazon Connect Service.
Deletes a user account from Amazon Connect.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation DeleteUser for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser
func (*Connect) DeleteUserRequest ¶ added in v1.15.2
func (c *Connect) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)
DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteUser for more information on using the DeleteUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteUserRequest method. req, resp := client.DeleteUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser
func (*Connect) DeleteUserWithContext ¶ added in v1.15.2
func (c *Connect) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)
DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.
See DeleteUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) DescribeUser ¶ added in v1.15.2
func (c *Connect) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)
DescribeUser API operation for Amazon Connect Service.
Returns a User object that contains information about the user account specified by the UserId.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation DescribeUser for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser
func (*Connect) DescribeUserHierarchyGroup ¶ added in v1.15.2
func (c *Connect) DescribeUserHierarchyGroup(input *DescribeUserHierarchyGroupInput) (*DescribeUserHierarchyGroupOutput, error)
DescribeUserHierarchyGroup API operation for Amazon Connect Service.
Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation DescribeUserHierarchyGroup for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup
func (*Connect) DescribeUserHierarchyGroupRequest ¶ added in v1.15.2
func (c *Connect) DescribeUserHierarchyGroupRequest(input *DescribeUserHierarchyGroupInput) (req *request.Request, output *DescribeUserHierarchyGroupOutput)
DescribeUserHierarchyGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeUserHierarchyGroup operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeUserHierarchyGroup for more information on using the DescribeUserHierarchyGroup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeUserHierarchyGroupRequest method. req, resp := client.DescribeUserHierarchyGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup
func (*Connect) DescribeUserHierarchyGroupWithContext ¶ added in v1.15.2
func (c *Connect) DescribeUserHierarchyGroupWithContext(ctx aws.Context, input *DescribeUserHierarchyGroupInput, opts ...request.Option) (*DescribeUserHierarchyGroupOutput, error)
DescribeUserHierarchyGroupWithContext is the same as DescribeUserHierarchyGroup with the addition of the ability to pass a context and additional request options.
See DescribeUserHierarchyGroup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) DescribeUserHierarchyStructure ¶ added in v1.15.2
func (c *Connect) DescribeUserHierarchyStructure(input *DescribeUserHierarchyStructureInput) (*DescribeUserHierarchyStructureOutput, error)
DescribeUserHierarchyStructure API operation for Amazon Connect Service.
Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation DescribeUserHierarchyStructure for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure
func (*Connect) DescribeUserHierarchyStructureRequest ¶ added in v1.15.2
func (c *Connect) DescribeUserHierarchyStructureRequest(input *DescribeUserHierarchyStructureInput) (req *request.Request, output *DescribeUserHierarchyStructureOutput)
DescribeUserHierarchyStructureRequest generates a "aws/request.Request" representing the client's request for the DescribeUserHierarchyStructure operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeUserHierarchyStructure for more information on using the DescribeUserHierarchyStructure API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeUserHierarchyStructureRequest method. req, resp := client.DescribeUserHierarchyStructureRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure
func (*Connect) DescribeUserHierarchyStructureWithContext ¶ added in v1.15.2
func (c *Connect) DescribeUserHierarchyStructureWithContext(ctx aws.Context, input *DescribeUserHierarchyStructureInput, opts ...request.Option) (*DescribeUserHierarchyStructureOutput, error)
DescribeUserHierarchyStructureWithContext is the same as DescribeUserHierarchyStructure with the addition of the ability to pass a context and additional request options.
See DescribeUserHierarchyStructure for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) DescribeUserRequest ¶ added in v1.15.2
func (c *Connect) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)
DescribeUserRequest generates a "aws/request.Request" representing the client's request for the DescribeUser operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeUser for more information on using the DescribeUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeUserRequest method. req, resp := client.DescribeUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser
func (*Connect) DescribeUserWithContext ¶ added in v1.15.2
func (c *Connect) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)
DescribeUserWithContext is the same as DescribeUser with the addition of the ability to pass a context and additional request options.
See DescribeUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) GetFederationToken ¶ added in v1.15.2
func (c *Connect) GetFederationToken(input *GetFederationTokenInput) (*GetFederationTokenOutput, error)
GetFederationToken API operation for Amazon Connect Service.
Retrieves a token for federation.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation GetFederationToken for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeUserNotFoundException "UserNotFoundException" No user with the specified credentials was found in the Amazon Connect instance.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
ErrCodeDuplicateResourceException "DuplicateResourceException" A resource with that name already exisits.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken
func (*Connect) GetFederationTokenRequest ¶ added in v1.15.2
func (c *Connect) GetFederationTokenRequest(input *GetFederationTokenInput) (req *request.Request, output *GetFederationTokenOutput)
GetFederationTokenRequest generates a "aws/request.Request" representing the client's request for the GetFederationToken operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetFederationToken for more information on using the GetFederationToken API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetFederationTokenRequest method. req, resp := client.GetFederationTokenRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken
func (*Connect) GetFederationTokenWithContext ¶ added in v1.15.2
func (c *Connect) GetFederationTokenWithContext(ctx aws.Context, input *GetFederationTokenInput, opts ...request.Option) (*GetFederationTokenOutput, error)
GetFederationTokenWithContext is the same as GetFederationToken with the addition of the ability to pass a context and additional request options.
See GetFederationToken for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) ListRoutingProfiles ¶ added in v1.15.2
func (c *Connect) ListRoutingProfiles(input *ListRoutingProfilesInput) (*ListRoutingProfilesOutput, error)
ListRoutingProfiles API operation for Amazon Connect Service.
Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation ListRoutingProfiles for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles
func (*Connect) ListRoutingProfilesRequest ¶ added in v1.15.2
func (c *Connect) ListRoutingProfilesRequest(input *ListRoutingProfilesInput) (req *request.Request, output *ListRoutingProfilesOutput)
ListRoutingProfilesRequest generates a "aws/request.Request" representing the client's request for the ListRoutingProfiles operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListRoutingProfiles for more information on using the ListRoutingProfiles API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListRoutingProfilesRequest method. req, resp := client.ListRoutingProfilesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles
func (*Connect) ListRoutingProfilesWithContext ¶ added in v1.15.2
func (c *Connect) ListRoutingProfilesWithContext(ctx aws.Context, input *ListRoutingProfilesInput, opts ...request.Option) (*ListRoutingProfilesOutput, error)
ListRoutingProfilesWithContext is the same as ListRoutingProfiles with the addition of the ability to pass a context and additional request options.
See ListRoutingProfiles for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) ListSecurityProfiles ¶ added in v1.15.2
func (c *Connect) ListSecurityProfiles(input *ListSecurityProfilesInput) (*ListSecurityProfilesOutput, error)
ListSecurityProfiles API operation for Amazon Connect Service.
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation ListSecurityProfiles for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles
func (*Connect) ListSecurityProfilesRequest ¶ added in v1.15.2
func (c *Connect) ListSecurityProfilesRequest(input *ListSecurityProfilesInput) (req *request.Request, output *ListSecurityProfilesOutput)
ListSecurityProfilesRequest generates a "aws/request.Request" representing the client's request for the ListSecurityProfiles operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListSecurityProfiles for more information on using the ListSecurityProfiles API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListSecurityProfilesRequest method. req, resp := client.ListSecurityProfilesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles
func (*Connect) ListSecurityProfilesWithContext ¶ added in v1.15.2
func (c *Connect) ListSecurityProfilesWithContext(ctx aws.Context, input *ListSecurityProfilesInput, opts ...request.Option) (*ListSecurityProfilesOutput, error)
ListSecurityProfilesWithContext is the same as ListSecurityProfiles with the addition of the ability to pass a context and additional request options.
See ListSecurityProfiles for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) ListUserHierarchyGroups ¶ added in v1.15.2
func (c *Connect) ListUserHierarchyGroups(input *ListUserHierarchyGroupsInput) (*ListUserHierarchyGroupsOutput, error)
ListUserHierarchyGroups API operation for Amazon Connect Service.
Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation ListUserHierarchyGroups for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups
func (*Connect) ListUserHierarchyGroupsRequest ¶ added in v1.15.2
func (c *Connect) ListUserHierarchyGroupsRequest(input *ListUserHierarchyGroupsInput) (req *request.Request, output *ListUserHierarchyGroupsOutput)
ListUserHierarchyGroupsRequest generates a "aws/request.Request" representing the client's request for the ListUserHierarchyGroups operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListUserHierarchyGroups for more information on using the ListUserHierarchyGroups API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListUserHierarchyGroupsRequest method. req, resp := client.ListUserHierarchyGroupsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups
func (*Connect) ListUserHierarchyGroupsWithContext ¶ added in v1.15.2
func (c *Connect) ListUserHierarchyGroupsWithContext(ctx aws.Context, input *ListUserHierarchyGroupsInput, opts ...request.Option) (*ListUserHierarchyGroupsOutput, error)
ListUserHierarchyGroupsWithContext is the same as ListUserHierarchyGroups with the addition of the ability to pass a context and additional request options.
See ListUserHierarchyGroups for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) ListUsers ¶ added in v1.15.2
func (c *Connect) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)
ListUsers API operation for Amazon Connect Service.
Returns a UserSummaryList, which is an array of UserSummary objects.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation ListUsers for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers
func (*Connect) ListUsersRequest ¶ added in v1.15.2
func (c *Connect) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)
ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListUsers for more information on using the ListUsers API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListUsersRequest method. req, resp := client.ListUsersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers
func (*Connect) ListUsersWithContext ¶ added in v1.15.2
func (c *Connect) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)
ListUsersWithContext is the same as ListUsers with the addition of the ability to pass a context and additional request options.
See ListUsers for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) StartOutboundVoiceContact ¶
func (c *Connect) StartOutboundVoiceContact(input *StartOutboundVoiceContactInput) (*StartOutboundVoiceContactOutput, error)
StartOutboundVoiceContact API operation for Amazon Connect Service.
The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.
There is a throttling limit placed on usage of the API that includes a RateLimit of 2 per second, and a BurstLimit of 5 per second.
If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation StartOutboundVoiceContact for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
ErrCodeLimitExceededException "LimitExceededException" The limit exceeded the maximum allowed active calls in a queue.
ErrCodeDestinationNotAllowedException "DestinationNotAllowedException" Outbound calls to the destination number are not allowed.
ErrCodeOutboundContactNotPermittedException "OutboundContactNotPermittedException" The contact is not permitted.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact
func (*Connect) StartOutboundVoiceContactRequest ¶
func (c *Connect) StartOutboundVoiceContactRequest(input *StartOutboundVoiceContactInput) (req *request.Request, output *StartOutboundVoiceContactOutput)
StartOutboundVoiceContactRequest generates a "aws/request.Request" representing the client's request for the StartOutboundVoiceContact operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartOutboundVoiceContact for more information on using the StartOutboundVoiceContact API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartOutboundVoiceContactRequest method. req, resp := client.StartOutboundVoiceContactRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact
func (*Connect) StartOutboundVoiceContactWithContext ¶
func (c *Connect) StartOutboundVoiceContactWithContext(ctx aws.Context, input *StartOutboundVoiceContactInput, opts ...request.Option) (*StartOutboundVoiceContactOutput, error)
StartOutboundVoiceContactWithContext is the same as StartOutboundVoiceContact with the addition of the ability to pass a context and additional request options.
See StartOutboundVoiceContact for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) StopContact ¶
func (c *Connect) StopContact(input *StopContactInput) (*StopContactOutput, error)
StopContact API operation for Amazon Connect Service.
Ends the contact initiated by the StartOutboundVoiceContact operation.
If you are using an IAM account, it must have permission to the connect:StopContact action.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation StopContact for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeContactNotFoundException "ContactNotFoundException" The contact with the specified ID is not active or does not exist.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact
func (*Connect) StopContactRequest ¶
func (c *Connect) StopContactRequest(input *StopContactInput) (req *request.Request, output *StopContactOutput)
StopContactRequest generates a "aws/request.Request" representing the client's request for the StopContact operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopContact for more information on using the StopContact API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopContactRequest method. req, resp := client.StopContactRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact
func (*Connect) StopContactWithContext ¶
func (c *Connect) StopContactWithContext(ctx aws.Context, input *StopContactInput, opts ...request.Option) (*StopContactOutput, error)
StopContactWithContext is the same as StopContact with the addition of the ability to pass a context and additional request options.
See StopContact for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) UpdateUserHierarchy ¶ added in v1.15.2
func (c *Connect) UpdateUserHierarchy(input *UpdateUserHierarchyInput) (*UpdateUserHierarchyOutput, error)
UpdateUserHierarchy API operation for Amazon Connect Service.
Assigns the specified hierarchy group to the user.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserHierarchy for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy
func (*Connect) UpdateUserHierarchyRequest ¶ added in v1.15.2
func (c *Connect) UpdateUserHierarchyRequest(input *UpdateUserHierarchyInput) (req *request.Request, output *UpdateUserHierarchyOutput)
UpdateUserHierarchyRequest generates a "aws/request.Request" representing the client's request for the UpdateUserHierarchy operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateUserHierarchy for more information on using the UpdateUserHierarchy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateUserHierarchyRequest method. req, resp := client.UpdateUserHierarchyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy
func (*Connect) UpdateUserHierarchyWithContext ¶ added in v1.15.2
func (c *Connect) UpdateUserHierarchyWithContext(ctx aws.Context, input *UpdateUserHierarchyInput, opts ...request.Option) (*UpdateUserHierarchyOutput, error)
UpdateUserHierarchyWithContext is the same as UpdateUserHierarchy with the addition of the ability to pass a context and additional request options.
See UpdateUserHierarchy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) UpdateUserIdentityInfo ¶ added in v1.15.2
func (c *Connect) UpdateUserIdentityInfo(input *UpdateUserIdentityInfoInput) (*UpdateUserIdentityInfoOutput, error)
UpdateUserIdentityInfo API operation for Amazon Connect Service.
Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserIdentityInfo for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo
func (*Connect) UpdateUserIdentityInfoRequest ¶ added in v1.15.2
func (c *Connect) UpdateUserIdentityInfoRequest(input *UpdateUserIdentityInfoInput) (req *request.Request, output *UpdateUserIdentityInfoOutput)
UpdateUserIdentityInfoRequest generates a "aws/request.Request" representing the client's request for the UpdateUserIdentityInfo operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateUserIdentityInfo for more information on using the UpdateUserIdentityInfo API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateUserIdentityInfoRequest method. req, resp := client.UpdateUserIdentityInfoRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo
func (*Connect) UpdateUserIdentityInfoWithContext ¶ added in v1.15.2
func (c *Connect) UpdateUserIdentityInfoWithContext(ctx aws.Context, input *UpdateUserIdentityInfoInput, opts ...request.Option) (*UpdateUserIdentityInfoOutput, error)
UpdateUserIdentityInfoWithContext is the same as UpdateUserIdentityInfo with the addition of the ability to pass a context and additional request options.
See UpdateUserIdentityInfo for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) UpdateUserPhoneConfig ¶ added in v1.15.2
func (c *Connect) UpdateUserPhoneConfig(input *UpdateUserPhoneConfigInput) (*UpdateUserPhoneConfigOutput, error)
UpdateUserPhoneConfig API operation for Amazon Connect Service.
Updates the phone configuration settings in the UserPhoneConfig object for the specified user.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserPhoneConfig for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig
func (*Connect) UpdateUserPhoneConfigRequest ¶ added in v1.15.2
func (c *Connect) UpdateUserPhoneConfigRequest(input *UpdateUserPhoneConfigInput) (req *request.Request, output *UpdateUserPhoneConfigOutput)
UpdateUserPhoneConfigRequest generates a "aws/request.Request" representing the client's request for the UpdateUserPhoneConfig operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateUserPhoneConfig for more information on using the UpdateUserPhoneConfig API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateUserPhoneConfigRequest method. req, resp := client.UpdateUserPhoneConfigRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig
func (*Connect) UpdateUserPhoneConfigWithContext ¶ added in v1.15.2
func (c *Connect) UpdateUserPhoneConfigWithContext(ctx aws.Context, input *UpdateUserPhoneConfigInput, opts ...request.Option) (*UpdateUserPhoneConfigOutput, error)
UpdateUserPhoneConfigWithContext is the same as UpdateUserPhoneConfig with the addition of the ability to pass a context and additional request options.
See UpdateUserPhoneConfig for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) UpdateUserRoutingProfile ¶ added in v1.15.2
func (c *Connect) UpdateUserRoutingProfile(input *UpdateUserRoutingProfileInput) (*UpdateUserRoutingProfileOutput, error)
UpdateUserRoutingProfile API operation for Amazon Connect Service.
Assigns the specified routing profile to a user.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserRoutingProfile for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile
func (*Connect) UpdateUserRoutingProfileRequest ¶ added in v1.15.2
func (c *Connect) UpdateUserRoutingProfileRequest(input *UpdateUserRoutingProfileInput) (req *request.Request, output *UpdateUserRoutingProfileOutput)
UpdateUserRoutingProfileRequest generates a "aws/request.Request" representing the client's request for the UpdateUserRoutingProfile operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateUserRoutingProfile for more information on using the UpdateUserRoutingProfile API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateUserRoutingProfileRequest method. req, resp := client.UpdateUserRoutingProfileRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile
func (*Connect) UpdateUserRoutingProfileWithContext ¶ added in v1.15.2
func (c *Connect) UpdateUserRoutingProfileWithContext(ctx aws.Context, input *UpdateUserRoutingProfileInput, opts ...request.Option) (*UpdateUserRoutingProfileOutput, error)
UpdateUserRoutingProfileWithContext is the same as UpdateUserRoutingProfile with the addition of the ability to pass a context and additional request options.
See UpdateUserRoutingProfile for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Connect) UpdateUserSecurityProfiles ¶ added in v1.15.2
func (c *Connect) UpdateUserSecurityProfiles(input *UpdateUserSecurityProfilesInput) (*UpdateUserSecurityProfilesOutput, error)
UpdateUserSecurityProfiles API operation for Amazon Connect Service.
Update the security profiles assigned to the user.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserSecurityProfiles for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.
ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.
ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles
func (*Connect) UpdateUserSecurityProfilesRequest ¶ added in v1.15.2
func (c *Connect) UpdateUserSecurityProfilesRequest(input *UpdateUserSecurityProfilesInput) (req *request.Request, output *UpdateUserSecurityProfilesOutput)
UpdateUserSecurityProfilesRequest generates a "aws/request.Request" representing the client's request for the UpdateUserSecurityProfiles operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateUserSecurityProfiles for more information on using the UpdateUserSecurityProfiles API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateUserSecurityProfilesRequest method. req, resp := client.UpdateUserSecurityProfilesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles
func (*Connect) UpdateUserSecurityProfilesWithContext ¶ added in v1.15.2
func (c *Connect) UpdateUserSecurityProfilesWithContext(ctx aws.Context, input *UpdateUserSecurityProfilesInput, opts ...request.Option) (*UpdateUserSecurityProfilesOutput, error)
UpdateUserSecurityProfilesWithContext is the same as UpdateUserSecurityProfiles with the addition of the ability to pass a context and additional request options.
See UpdateUserSecurityProfiles for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type CreateUserInput ¶ added in v1.15.2
type CreateUserInput struct { // The unique identifier for the user account in the directory service directory // used for identity management. If Amazon Connect is unable to access the existing // directory, you can use the DirectoryUserId to authenticate users. If you // include the parameter, it is assumed that Amazon Connect cannot access the // directory. If the parameter is not included, the UserIdentityInfo is used // to authenticate users from your existing directory. // // This parameter is required if you are using an existing directory for identity // management in Amazon Connect when Amazon Connect cannot access your directory // to authenticate users. If you are using SAML for identity management and // include this parameter, an InvalidRequestException is returned. DirectoryUserId *string `type:"string"` // The unique identifier for the hierarchy group to assign to the user created. HierarchyGroupId *string `type:"string"` // Information about the user, including email address, first name, and last // name. IdentityInfo *UserIdentityInfo `type:"structure"` // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The password for the user account to create. This is required if you are // using Amazon Connect for identity management. If you are using SAML for identity // management and include this parameter, an InvalidRequestException is returned. Password *string `type:"string"` // Specifies the phone settings for the user, including AfterContactWorkTimeLimit, // AutoAccept, DeskPhoneNumber, and PhoneType. // // PhoneConfig is a required field PhoneConfig *UserPhoneConfig `type:"structure" required:"true"` // The unique identifier for the routing profile to assign to the user created. // // RoutingProfileId is a required field RoutingProfileId *string `type:"string" required:"true"` // The unique identifier of the security profile to assign to the user created. // // SecurityProfileIds is a required field SecurityProfileIds []*string `min:"1" type:"list" required:"true"` // The user name in Amazon Connect for the user to create. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (CreateUserInput) GoString ¶ added in v1.15.2
func (s CreateUserInput) GoString() string
GoString returns the string representation
func (*CreateUserInput) SetDirectoryUserId ¶ added in v1.15.2
func (s *CreateUserInput) SetDirectoryUserId(v string) *CreateUserInput
SetDirectoryUserId sets the DirectoryUserId field's value.
func (*CreateUserInput) SetHierarchyGroupId ¶ added in v1.15.2
func (s *CreateUserInput) SetHierarchyGroupId(v string) *CreateUserInput
SetHierarchyGroupId sets the HierarchyGroupId field's value.
func (*CreateUserInput) SetIdentityInfo ¶ added in v1.15.2
func (s *CreateUserInput) SetIdentityInfo(v *UserIdentityInfo) *CreateUserInput
SetIdentityInfo sets the IdentityInfo field's value.
func (*CreateUserInput) SetInstanceId ¶ added in v1.15.2
func (s *CreateUserInput) SetInstanceId(v string) *CreateUserInput
SetInstanceId sets the InstanceId field's value.
func (*CreateUserInput) SetPassword ¶ added in v1.15.2
func (s *CreateUserInput) SetPassword(v string) *CreateUserInput
SetPassword sets the Password field's value.
func (*CreateUserInput) SetPhoneConfig ¶ added in v1.15.2
func (s *CreateUserInput) SetPhoneConfig(v *UserPhoneConfig) *CreateUserInput
SetPhoneConfig sets the PhoneConfig field's value.
func (*CreateUserInput) SetRoutingProfileId ¶ added in v1.15.2
func (s *CreateUserInput) SetRoutingProfileId(v string) *CreateUserInput
SetRoutingProfileId sets the RoutingProfileId field's value.
func (*CreateUserInput) SetSecurityProfileIds ¶ added in v1.15.2
func (s *CreateUserInput) SetSecurityProfileIds(v []*string) *CreateUserInput
SetSecurityProfileIds sets the SecurityProfileIds field's value.
func (*CreateUserInput) SetUsername ¶ added in v1.15.2
func (s *CreateUserInput) SetUsername(v string) *CreateUserInput
SetUsername sets the Username field's value.
func (CreateUserInput) String ¶ added in v1.15.2
func (s CreateUserInput) String() string
String returns the string representation
func (*CreateUserInput) Validate ¶ added in v1.15.2
func (s *CreateUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUserOutput ¶ added in v1.15.2
type CreateUserOutput struct { // The Amazon Resource Name (ARN) of the user account created. UserArn *string `type:"string"` // The unique identifier for the user account in Amazon Connect UserId *string `type:"string"` // contains filtered or unexported fields }
func (CreateUserOutput) GoString ¶ added in v1.15.2
func (s CreateUserOutput) GoString() string
GoString returns the string representation
func (*CreateUserOutput) SetUserArn ¶ added in v1.15.2
func (s *CreateUserOutput) SetUserArn(v string) *CreateUserOutput
SetUserArn sets the UserArn field's value.
func (*CreateUserOutput) SetUserId ¶ added in v1.15.2
func (s *CreateUserOutput) SetUserId(v string) *CreateUserOutput
SetUserId sets the UserId field's value.
func (CreateUserOutput) String ¶ added in v1.15.2
func (s CreateUserOutput) String() string
String returns the string representation
type Credentials ¶ added in v1.15.2
type Credentials struct { // An access token generated for a federated user to access Amazon Connect AccessToken *string `type:"string"` // 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"` // Renews the expiration timer for a generated token. RefreshTokenExpiration *time.Time `type:"timestamp"` // contains filtered or unexported fields }
The credentials to use for federation.
func (Credentials) GoString ¶ added in v1.15.2
func (s Credentials) GoString() string
GoString returns the string representation
func (*Credentials) SetAccessToken ¶ added in v1.15.2
func (s *Credentials) SetAccessToken(v string) *Credentials
SetAccessToken sets the AccessToken field's value.
func (*Credentials) SetAccessTokenExpiration ¶ added in v1.15.2
func (s *Credentials) SetAccessTokenExpiration(v time.Time) *Credentials
SetAccessTokenExpiration sets the AccessTokenExpiration field's value.
func (*Credentials) SetRefreshToken ¶ added in v1.15.2
func (s *Credentials) SetRefreshToken(v string) *Credentials
SetRefreshToken sets the RefreshToken field's value.
func (*Credentials) SetRefreshTokenExpiration ¶ added in v1.15.2
func (s *Credentials) SetRefreshTokenExpiration(v time.Time) *Credentials
SetRefreshTokenExpiration sets the RefreshTokenExpiration field's value.
func (Credentials) String ¶ added in v1.15.2
func (s Credentials) String() string
String returns the string representation
type DeleteUserInput ¶ added in v1.15.2
type DeleteUserInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The unique identifier of the user to delete. // // UserId is a required field UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteUserInput) GoString ¶ added in v1.15.2
func (s DeleteUserInput) GoString() string
GoString returns the string representation
func (*DeleteUserInput) SetInstanceId ¶ added in v1.15.2
func (s *DeleteUserInput) SetInstanceId(v string) *DeleteUserInput
SetInstanceId sets the InstanceId field's value.
func (*DeleteUserInput) SetUserId ¶ added in v1.15.2
func (s *DeleteUserInput) SetUserId(v string) *DeleteUserInput
SetUserId sets the UserId field's value.
func (DeleteUserInput) String ¶ added in v1.15.2
func (s DeleteUserInput) String() string
String returns the string representation
func (*DeleteUserInput) Validate ¶ added in v1.15.2
func (s *DeleteUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserOutput ¶ added in v1.15.2
type DeleteUserOutput struct {
// contains filtered or unexported fields
}
func (DeleteUserOutput) GoString ¶ added in v1.15.2
func (s DeleteUserOutput) GoString() string
GoString returns the string representation
func (DeleteUserOutput) String ¶ added in v1.15.2
func (s DeleteUserOutput) String() string
String returns the string representation
type DescribeUserHierarchyGroupInput ¶ added in v1.15.2
type DescribeUserHierarchyGroupInput struct { // The identifier for the hierarchy group to return. // // HierarchyGroupId is a required field HierarchyGroupId *string `location:"uri" locationName:"HierarchyGroupId" type:"string" required:"true"` // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeUserHierarchyGroupInput) GoString ¶ added in v1.15.2
func (s DescribeUserHierarchyGroupInput) GoString() string
GoString returns the string representation
func (*DescribeUserHierarchyGroupInput) SetHierarchyGroupId ¶ added in v1.15.2
func (s *DescribeUserHierarchyGroupInput) SetHierarchyGroupId(v string) *DescribeUserHierarchyGroupInput
SetHierarchyGroupId sets the HierarchyGroupId field's value.
func (*DescribeUserHierarchyGroupInput) SetInstanceId ¶ added in v1.15.2
func (s *DescribeUserHierarchyGroupInput) SetInstanceId(v string) *DescribeUserHierarchyGroupInput
SetInstanceId sets the InstanceId field's value.
func (DescribeUserHierarchyGroupInput) String ¶ added in v1.15.2
func (s DescribeUserHierarchyGroupInput) String() string
String returns the string representation
func (*DescribeUserHierarchyGroupInput) Validate ¶ added in v1.15.2
func (s *DescribeUserHierarchyGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeUserHierarchyGroupOutput ¶ added in v1.15.2
type DescribeUserHierarchyGroupOutput struct { // Returns a HierarchyGroup object. HierarchyGroup *HierarchyGroup `type:"structure"` // contains filtered or unexported fields }
func (DescribeUserHierarchyGroupOutput) GoString ¶ added in v1.15.2
func (s DescribeUserHierarchyGroupOutput) GoString() string
GoString returns the string representation
func (*DescribeUserHierarchyGroupOutput) SetHierarchyGroup ¶ added in v1.15.2
func (s *DescribeUserHierarchyGroupOutput) SetHierarchyGroup(v *HierarchyGroup) *DescribeUserHierarchyGroupOutput
SetHierarchyGroup sets the HierarchyGroup field's value.
func (DescribeUserHierarchyGroupOutput) String ¶ added in v1.15.2
func (s DescribeUserHierarchyGroupOutput) String() string
String returns the string representation
type DescribeUserHierarchyStructureInput ¶ added in v1.15.2
type DescribeUserHierarchyStructureInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeUserHierarchyStructureInput) GoString ¶ added in v1.15.2
func (s DescribeUserHierarchyStructureInput) GoString() string
GoString returns the string representation
func (*DescribeUserHierarchyStructureInput) SetInstanceId ¶ added in v1.15.2
func (s *DescribeUserHierarchyStructureInput) SetInstanceId(v string) *DescribeUserHierarchyStructureInput
SetInstanceId sets the InstanceId field's value.
func (DescribeUserHierarchyStructureInput) String ¶ added in v1.15.2
func (s DescribeUserHierarchyStructureInput) String() string
String returns the string representation
func (*DescribeUserHierarchyStructureInput) Validate ¶ added in v1.15.2
func (s *DescribeUserHierarchyStructureInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeUserHierarchyStructureOutput ¶ added in v1.15.2
type DescribeUserHierarchyStructureOutput struct { // A HierarchyStructure object. HierarchyStructure *HierarchyStructure `type:"structure"` // contains filtered or unexported fields }
func (DescribeUserHierarchyStructureOutput) GoString ¶ added in v1.15.2
func (s DescribeUserHierarchyStructureOutput) GoString() string
GoString returns the string representation
func (*DescribeUserHierarchyStructureOutput) SetHierarchyStructure ¶ added in v1.15.2
func (s *DescribeUserHierarchyStructureOutput) SetHierarchyStructure(v *HierarchyStructure) *DescribeUserHierarchyStructureOutput
SetHierarchyStructure sets the HierarchyStructure field's value.
func (DescribeUserHierarchyStructureOutput) String ¶ added in v1.15.2
func (s DescribeUserHierarchyStructureOutput) String() string
String returns the string representation
type DescribeUserInput ¶ added in v1.15.2
type DescribeUserInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // Unique identifier for the user account to return. // // UserId is a required field UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeUserInput) GoString ¶ added in v1.15.2
func (s DescribeUserInput) GoString() string
GoString returns the string representation
func (*DescribeUserInput) SetInstanceId ¶ added in v1.15.2
func (s *DescribeUserInput) SetInstanceId(v string) *DescribeUserInput
SetInstanceId sets the InstanceId field's value.
func (*DescribeUserInput) SetUserId ¶ added in v1.15.2
func (s *DescribeUserInput) SetUserId(v string) *DescribeUserInput
SetUserId sets the UserId field's value.
func (DescribeUserInput) String ¶ added in v1.15.2
func (s DescribeUserInput) String() string
String returns the string representation
func (*DescribeUserInput) Validate ¶ added in v1.15.2
func (s *DescribeUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeUserOutput ¶ added in v1.15.2
type DescribeUserOutput struct { // A User object that contains information about the user account and configuration // settings. User *User `type:"structure"` // contains filtered or unexported fields }
func (DescribeUserOutput) GoString ¶ added in v1.15.2
func (s DescribeUserOutput) GoString() string
GoString returns the string representation
func (*DescribeUserOutput) SetUser ¶ added in v1.15.2
func (s *DescribeUserOutput) SetUser(v *User) *DescribeUserOutput
SetUser sets the User field's value.
func (DescribeUserOutput) String ¶ added in v1.15.2
func (s DescribeUserOutput) String() string
String returns the string representation
type GetFederationTokenInput ¶ added in v1.15.2
type GetFederationTokenInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetFederationTokenInput) GoString ¶ added in v1.15.2
func (s GetFederationTokenInput) GoString() string
GoString returns the string representation
func (*GetFederationTokenInput) SetInstanceId ¶ added in v1.15.2
func (s *GetFederationTokenInput) SetInstanceId(v string) *GetFederationTokenInput
SetInstanceId sets the InstanceId field's value.
func (GetFederationTokenInput) String ¶ added in v1.15.2
func (s GetFederationTokenInput) String() string
String returns the string representation
func (*GetFederationTokenInput) Validate ¶ added in v1.15.2
func (s *GetFederationTokenInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetFederationTokenOutput ¶ added in v1.15.2
type GetFederationTokenOutput struct { // The credentials to use for federation. Credentials *Credentials `type:"structure"` // contains filtered or unexported fields }
func (GetFederationTokenOutput) GoString ¶ added in v1.15.2
func (s GetFederationTokenOutput) GoString() string
GoString returns the string representation
func (*GetFederationTokenOutput) SetCredentials ¶ added in v1.15.2
func (s *GetFederationTokenOutput) SetCredentials(v *Credentials) *GetFederationTokenOutput
SetCredentials sets the Credentials field's value.
func (GetFederationTokenOutput) String ¶ added in v1.15.2
func (s GetFederationTokenOutput) String() string
String returns the string representation
type HierarchyGroup ¶ added in v1.15.2
type HierarchyGroup struct { // The Amazon Resource Name (ARN) for the hierarchy group. Arn *string `type:"string"` // A HierarchyPath object that contains information about the levels in the // hierarchy group. HierarchyPath *HierarchyPath `type:"structure"` // The identifier for the hierarchy group. Id *string `type:"string"` // The identifier for the level in the hierarchy group. LevelId *string `type:"string"` // The name of the hierarchy group in your instance. Name *string `type:"string"` // contains filtered or unexported fields }
A HierarchyGroup object that contains information about a hierarchy group in your Amazon Connect instance.
func (HierarchyGroup) GoString ¶ added in v1.15.2
func (s HierarchyGroup) GoString() string
GoString returns the string representation
func (*HierarchyGroup) SetArn ¶ added in v1.15.2
func (s *HierarchyGroup) SetArn(v string) *HierarchyGroup
SetArn sets the Arn field's value.
func (*HierarchyGroup) SetHierarchyPath ¶ added in v1.15.2
func (s *HierarchyGroup) SetHierarchyPath(v *HierarchyPath) *HierarchyGroup
SetHierarchyPath sets the HierarchyPath field's value.
func (*HierarchyGroup) SetId ¶ added in v1.15.2
func (s *HierarchyGroup) SetId(v string) *HierarchyGroup
SetId sets the Id field's value.
func (*HierarchyGroup) SetLevelId ¶ added in v1.15.2
func (s *HierarchyGroup) SetLevelId(v string) *HierarchyGroup
SetLevelId sets the LevelId field's value.
func (*HierarchyGroup) SetName ¶ added in v1.15.2
func (s *HierarchyGroup) SetName(v string) *HierarchyGroup
SetName sets the Name field's value.
func (HierarchyGroup) String ¶ added in v1.15.2
func (s HierarchyGroup) String() string
String returns the string representation
type HierarchyGroupSummary ¶ added in v1.15.2
type HierarchyGroupSummary struct { // The ARN for the hierarchy group. Arn *string `type:"string"` // The identifier of the hierarchy group. Id *string `type:"string"` // The name of the hierarchy group. Name *string `type:"string"` // contains filtered or unexported fields }
A HierarchyGroupSummary object that contains information about the hierarchy group, including ARN, Id, and Name.
func (HierarchyGroupSummary) GoString ¶ added in v1.15.2
func (s HierarchyGroupSummary) GoString() string
GoString returns the string representation
func (*HierarchyGroupSummary) SetArn ¶ added in v1.15.2
func (s *HierarchyGroupSummary) SetArn(v string) *HierarchyGroupSummary
SetArn sets the Arn field's value.
func (*HierarchyGroupSummary) SetId ¶ added in v1.15.2
func (s *HierarchyGroupSummary) SetId(v string) *HierarchyGroupSummary
SetId sets the Id field's value.
func (*HierarchyGroupSummary) SetName ¶ added in v1.15.2
func (s *HierarchyGroupSummary) SetName(v string) *HierarchyGroupSummary
SetName sets the Name field's value.
func (HierarchyGroupSummary) String ¶ added in v1.15.2
func (s HierarchyGroupSummary) String() string
String returns the string representation
type HierarchyLevel ¶ added in v1.15.2
type HierarchyLevel struct { // The ARN for the hierarchy group level. Arn *string `type:"string"` // The identifier for the hierarchy group level. Id *string `type:"string"` // The name of the hierarchy group level. Name *string `type:"string"` // contains filtered or unexported fields }
A HierarchyLevel object that contains information about the levels in a hierarchy group, including ARN, Id, and Name.
func (HierarchyLevel) GoString ¶ added in v1.15.2
func (s HierarchyLevel) GoString() string
GoString returns the string representation
func (*HierarchyLevel) SetArn ¶ added in v1.15.2
func (s *HierarchyLevel) SetArn(v string) *HierarchyLevel
SetArn sets the Arn field's value.
func (*HierarchyLevel) SetId ¶ added in v1.15.2
func (s *HierarchyLevel) SetId(v string) *HierarchyLevel
SetId sets the Id field's value.
func (*HierarchyLevel) SetName ¶ added in v1.15.2
func (s *HierarchyLevel) SetName(v string) *HierarchyLevel
SetName sets the Name field's value.
func (HierarchyLevel) String ¶ added in v1.15.2
func (s HierarchyLevel) String() string
String returns the string representation
type HierarchyPath ¶ added in v1.15.2
type HierarchyPath struct { // A HierarchyGroupSummary object that contains information about the level // of the hierarchy group, including ARN, Id, and Name. LevelFive *HierarchyGroupSummary `type:"structure"` // A HierarchyGroupSummary object that contains information about the level // of the hierarchy group, including ARN, Id, and Name. LevelFour *HierarchyGroupSummary `type:"structure"` // A HierarchyGroupSummary object that contains information about the level // of the hierarchy group, including ARN, Id, and Name. LevelOne *HierarchyGroupSummary `type:"structure"` // A HierarchyGroupSummary object that contains information about the level // of the hierarchy group, including ARN, Id, and Name. LevelThree *HierarchyGroupSummary `type:"structure"` // A HierarchyGroupSummary object that contains information about the level // of the hierarchy group, including ARN, Id, and Name. LevelTwo *HierarchyGroupSummary `type:"structure"` // contains filtered or unexported fields }
A HierarchyPath object that contains information about the levels of the hierarchy group.
func (HierarchyPath) GoString ¶ added in v1.15.2
func (s HierarchyPath) GoString() string
GoString returns the string representation
func (*HierarchyPath) SetLevelFive ¶ added in v1.15.2
func (s *HierarchyPath) SetLevelFive(v *HierarchyGroupSummary) *HierarchyPath
SetLevelFive sets the LevelFive field's value.
func (*HierarchyPath) SetLevelFour ¶ added in v1.15.2
func (s *HierarchyPath) SetLevelFour(v *HierarchyGroupSummary) *HierarchyPath
SetLevelFour sets the LevelFour field's value.
func (*HierarchyPath) SetLevelOne ¶ added in v1.15.2
func (s *HierarchyPath) SetLevelOne(v *HierarchyGroupSummary) *HierarchyPath
SetLevelOne sets the LevelOne field's value.
func (*HierarchyPath) SetLevelThree ¶ added in v1.15.2
func (s *HierarchyPath) SetLevelThree(v *HierarchyGroupSummary) *HierarchyPath
SetLevelThree sets the LevelThree field's value.
func (*HierarchyPath) SetLevelTwo ¶ added in v1.15.2
func (s *HierarchyPath) SetLevelTwo(v *HierarchyGroupSummary) *HierarchyPath
SetLevelTwo sets the LevelTwo field's value.
func (HierarchyPath) String ¶ added in v1.15.2
func (s HierarchyPath) String() string
String returns the string representation
type HierarchyStructure ¶ added in v1.15.2
type HierarchyStructure struct { // A HierarchyLevel object that contains information about the hierarchy group // level. LevelFive *HierarchyLevel `type:"structure"` // A HierarchyLevel object that contains information about the hierarchy group // level. LevelFour *HierarchyLevel `type:"structure"` // A HierarchyLevel object that contains information about the hierarchy group // level. LevelOne *HierarchyLevel `type:"structure"` // A HierarchyLevel object that contains information about the hierarchy group // level. LevelThree *HierarchyLevel `type:"structure"` // A HierarchyLevel object that contains information about the hierarchy group // level. LevelTwo *HierarchyLevel `type:"structure"` // contains filtered or unexported fields }
A HierarchyStructure object that contains information about the hierarchy group structure.
func (HierarchyStructure) GoString ¶ added in v1.15.2
func (s HierarchyStructure) GoString() string
GoString returns the string representation
func (*HierarchyStructure) SetLevelFive ¶ added in v1.15.2
func (s *HierarchyStructure) SetLevelFive(v *HierarchyLevel) *HierarchyStructure
SetLevelFive sets the LevelFive field's value.
func (*HierarchyStructure) SetLevelFour ¶ added in v1.15.2
func (s *HierarchyStructure) SetLevelFour(v *HierarchyLevel) *HierarchyStructure
SetLevelFour sets the LevelFour field's value.
func (*HierarchyStructure) SetLevelOne ¶ added in v1.15.2
func (s *HierarchyStructure) SetLevelOne(v *HierarchyLevel) *HierarchyStructure
SetLevelOne sets the LevelOne field's value.
func (*HierarchyStructure) SetLevelThree ¶ added in v1.15.2
func (s *HierarchyStructure) SetLevelThree(v *HierarchyLevel) *HierarchyStructure
SetLevelThree sets the LevelThree field's value.
func (*HierarchyStructure) SetLevelTwo ¶ added in v1.15.2
func (s *HierarchyStructure) SetLevelTwo(v *HierarchyLevel) *HierarchyStructure
SetLevelTwo sets the LevelTwo field's value.
func (HierarchyStructure) String ¶ added in v1.15.2
func (s HierarchyStructure) String() string
String returns the string representation
type ListRoutingProfilesInput ¶ added in v1.15.2
type ListRoutingProfilesInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximum number of routing profiles to return in the response. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListRoutingProfilesInput) GoString ¶ added in v1.15.2
func (s ListRoutingProfilesInput) GoString() string
GoString returns the string representation
func (*ListRoutingProfilesInput) SetInstanceId ¶ added in v1.15.2
func (s *ListRoutingProfilesInput) SetInstanceId(v string) *ListRoutingProfilesInput
SetInstanceId sets the InstanceId field's value.
func (*ListRoutingProfilesInput) SetMaxResults ¶ added in v1.15.2
func (s *ListRoutingProfilesInput) SetMaxResults(v int64) *ListRoutingProfilesInput
SetMaxResults sets the MaxResults field's value.
func (*ListRoutingProfilesInput) SetNextToken ¶ added in v1.15.2
func (s *ListRoutingProfilesInput) SetNextToken(v string) *ListRoutingProfilesInput
SetNextToken sets the NextToken field's value.
func (ListRoutingProfilesInput) String ¶ added in v1.15.2
func (s ListRoutingProfilesInput) String() string
String returns the string representation
func (*ListRoutingProfilesInput) Validate ¶ added in v1.15.2
func (s *ListRoutingProfilesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListRoutingProfilesOutput ¶ added in v1.15.2
type ListRoutingProfilesOutput struct { // A string returned in the response. Use the value returned in the response // as the value of the NextToken in a subsequent request to retrieve the next // set of results. NextToken *string `type:"string"` // An array of RoutingProfileSummary objects that include the ARN, Id, and Name // of the routing profile. RoutingProfileSummaryList []*RoutingProfileSummary `type:"list"` // contains filtered or unexported fields }
func (ListRoutingProfilesOutput) GoString ¶ added in v1.15.2
func (s ListRoutingProfilesOutput) GoString() string
GoString returns the string representation
func (*ListRoutingProfilesOutput) SetNextToken ¶ added in v1.15.2
func (s *ListRoutingProfilesOutput) SetNextToken(v string) *ListRoutingProfilesOutput
SetNextToken sets the NextToken field's value.
func (*ListRoutingProfilesOutput) SetRoutingProfileSummaryList ¶ added in v1.15.2
func (s *ListRoutingProfilesOutput) SetRoutingProfileSummaryList(v []*RoutingProfileSummary) *ListRoutingProfilesOutput
SetRoutingProfileSummaryList sets the RoutingProfileSummaryList field's value.
func (ListRoutingProfilesOutput) String ¶ added in v1.15.2
func (s ListRoutingProfilesOutput) String() string
String returns the string representation
type ListSecurityProfilesInput ¶ added in v1.15.2
type ListSecurityProfilesInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximum number of security profiles to return. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListSecurityProfilesInput) GoString ¶ added in v1.15.2
func (s ListSecurityProfilesInput) GoString() string
GoString returns the string representation
func (*ListSecurityProfilesInput) SetInstanceId ¶ added in v1.15.2
func (s *ListSecurityProfilesInput) SetInstanceId(v string) *ListSecurityProfilesInput
SetInstanceId sets the InstanceId field's value.
func (*ListSecurityProfilesInput) SetMaxResults ¶ added in v1.15.2
func (s *ListSecurityProfilesInput) SetMaxResults(v int64) *ListSecurityProfilesInput
SetMaxResults sets the MaxResults field's value.
func (*ListSecurityProfilesInput) SetNextToken ¶ added in v1.15.2
func (s *ListSecurityProfilesInput) SetNextToken(v string) *ListSecurityProfilesInput
SetNextToken sets the NextToken field's value.
func (ListSecurityProfilesInput) String ¶ added in v1.15.2
func (s ListSecurityProfilesInput) String() string
String returns the string representation
func (*ListSecurityProfilesInput) Validate ¶ added in v1.15.2
func (s *ListSecurityProfilesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListSecurityProfilesOutput ¶ added in v1.15.2
type ListSecurityProfilesOutput struct { // A string returned in the response. Use the value returned in the response // as the value of the NextToken in a subsequent request to retrieve the next // set of results. NextToken *string `type:"string"` // An array of SecurityProfileSummary objects. SecurityProfileSummaryList []*SecurityProfileSummary `type:"list"` // contains filtered or unexported fields }
func (ListSecurityProfilesOutput) GoString ¶ added in v1.15.2
func (s ListSecurityProfilesOutput) GoString() string
GoString returns the string representation
func (*ListSecurityProfilesOutput) SetNextToken ¶ added in v1.15.2
func (s *ListSecurityProfilesOutput) SetNextToken(v string) *ListSecurityProfilesOutput
SetNextToken sets the NextToken field's value.
func (*ListSecurityProfilesOutput) SetSecurityProfileSummaryList ¶ added in v1.15.2
func (s *ListSecurityProfilesOutput) SetSecurityProfileSummaryList(v []*SecurityProfileSummary) *ListSecurityProfilesOutput
SetSecurityProfileSummaryList sets the SecurityProfileSummaryList field's value.
func (ListSecurityProfilesOutput) String ¶ added in v1.15.2
func (s ListSecurityProfilesOutput) String() string
String returns the string representation
type ListUserHierarchyGroupsInput ¶ added in v1.15.2
type ListUserHierarchyGroupsInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximum number of hierarchy groups to return. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListUserHierarchyGroupsInput) GoString ¶ added in v1.15.2
func (s ListUserHierarchyGroupsInput) GoString() string
GoString returns the string representation
func (*ListUserHierarchyGroupsInput) SetInstanceId ¶ added in v1.15.2
func (s *ListUserHierarchyGroupsInput) SetInstanceId(v string) *ListUserHierarchyGroupsInput
SetInstanceId sets the InstanceId field's value.
func (*ListUserHierarchyGroupsInput) SetMaxResults ¶ added in v1.15.2
func (s *ListUserHierarchyGroupsInput) SetMaxResults(v int64) *ListUserHierarchyGroupsInput
SetMaxResults sets the MaxResults field's value.
func (*ListUserHierarchyGroupsInput) SetNextToken ¶ added in v1.15.2
func (s *ListUserHierarchyGroupsInput) SetNextToken(v string) *ListUserHierarchyGroupsInput
SetNextToken sets the NextToken field's value.
func (ListUserHierarchyGroupsInput) String ¶ added in v1.15.2
func (s ListUserHierarchyGroupsInput) String() string
String returns the string representation
func (*ListUserHierarchyGroupsInput) Validate ¶ added in v1.15.2
func (s *ListUserHierarchyGroupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListUserHierarchyGroupsOutput ¶ added in v1.15.2
type ListUserHierarchyGroupsOutput struct { // A string returned in the response. Use the value returned in the response // as the value of the NextToken in a subsequent request to retrieve the next // set of results. NextToken *string `type:"string"` // An array of HierarchyGroupSummary objects. UserHierarchyGroupSummaryList []*HierarchyGroupSummary `type:"list"` // contains filtered or unexported fields }
func (ListUserHierarchyGroupsOutput) GoString ¶ added in v1.15.2
func (s ListUserHierarchyGroupsOutput) GoString() string
GoString returns the string representation
func (*ListUserHierarchyGroupsOutput) SetNextToken ¶ added in v1.15.2
func (s *ListUserHierarchyGroupsOutput) SetNextToken(v string) *ListUserHierarchyGroupsOutput
SetNextToken sets the NextToken field's value.
func (*ListUserHierarchyGroupsOutput) SetUserHierarchyGroupSummaryList ¶ added in v1.15.2
func (s *ListUserHierarchyGroupsOutput) SetUserHierarchyGroupSummaryList(v []*HierarchyGroupSummary) *ListUserHierarchyGroupsOutput
SetUserHierarchyGroupSummaryList sets the UserHierarchyGroupSummaryList field's value.
func (ListUserHierarchyGroupsOutput) String ¶ added in v1.15.2
func (s ListUserHierarchyGroupsOutput) String() string
String returns the string representation
type ListUsersInput ¶ added in v1.15.2
type ListUsersInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The maximum number of results to return in the response. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListUsersInput) GoString ¶ added in v1.15.2
func (s ListUsersInput) GoString() string
GoString returns the string representation
func (*ListUsersInput) SetInstanceId ¶ added in v1.15.2
func (s *ListUsersInput) SetInstanceId(v string) *ListUsersInput
SetInstanceId sets the InstanceId field's value.
func (*ListUsersInput) SetMaxResults ¶ added in v1.15.2
func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput
SetMaxResults sets the MaxResults field's value.
func (*ListUsersInput) SetNextToken ¶ added in v1.15.2
func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput
SetNextToken sets the NextToken field's value.
func (ListUsersInput) String ¶ added in v1.15.2
func (s ListUsersInput) String() string
String returns the string representation
func (*ListUsersInput) Validate ¶ added in v1.15.2
func (s *ListUsersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListUsersOutput ¶ added in v1.15.2
type ListUsersOutput struct { // A string returned in the response. Use the value returned in the response // as the value of the NextToken in a subsequent request to retrieve the next // set of results. NextToken *string `type:"string"` // An array of UserSummary objects that contain information about the users // in your instance. UserSummaryList []*UserSummary `type:"list"` // contains filtered or unexported fields }
func (ListUsersOutput) GoString ¶ added in v1.15.2
func (s ListUsersOutput) GoString() string
GoString returns the string representation
func (*ListUsersOutput) SetNextToken ¶ added in v1.15.2
func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput
SetNextToken sets the NextToken field's value.
func (*ListUsersOutput) SetUserSummaryList ¶ added in v1.15.2
func (s *ListUsersOutput) SetUserSummaryList(v []*UserSummary) *ListUsersOutput
SetUserSummaryList sets the UserSummaryList field's value.
func (ListUsersOutput) String ¶ added in v1.15.2
func (s ListUsersOutput) String() string
String returns the string representation
type RoutingProfileSummary ¶ added in v1.15.2
type RoutingProfileSummary struct { // The ARN of the routing profile. Arn *string `type:"string"` // The identifier of the routing profile. Id *string `type:"string"` // The name of the routing profile. Name *string `min:"1" type:"string"` // contains filtered or unexported fields }
A RoutingProfileSummary object that contains information about a routing profile, including ARN, Id, and Name.
func (RoutingProfileSummary) GoString ¶ added in v1.15.2
func (s RoutingProfileSummary) GoString() string
GoString returns the string representation
func (*RoutingProfileSummary) SetArn ¶ added in v1.15.2
func (s *RoutingProfileSummary) SetArn(v string) *RoutingProfileSummary
SetArn sets the Arn field's value.
func (*RoutingProfileSummary) SetId ¶ added in v1.15.2
func (s *RoutingProfileSummary) SetId(v string) *RoutingProfileSummary
SetId sets the Id field's value.
func (*RoutingProfileSummary) SetName ¶ added in v1.15.2
func (s *RoutingProfileSummary) SetName(v string) *RoutingProfileSummary
SetName sets the Name field's value.
func (RoutingProfileSummary) String ¶ added in v1.15.2
func (s RoutingProfileSummary) String() string
String returns the string representation
type SecurityProfileSummary ¶ added in v1.15.2
type SecurityProfileSummary struct { // The ARN of the security profile. Arn *string `type:"string"` // The identifier of the security profile. Id *string `type:"string"` // The name of the security profile. Name *string `type:"string"` // contains filtered or unexported fields }
A SecurityProfileSummary object that contains information about a security profile, including ARN, Id, Name.
func (SecurityProfileSummary) GoString ¶ added in v1.15.2
func (s SecurityProfileSummary) GoString() string
GoString returns the string representation
func (*SecurityProfileSummary) SetArn ¶ added in v1.15.2
func (s *SecurityProfileSummary) SetArn(v string) *SecurityProfileSummary
SetArn sets the Arn field's value.
func (*SecurityProfileSummary) SetId ¶ added in v1.15.2
func (s *SecurityProfileSummary) SetId(v string) *SecurityProfileSummary
SetId sets the Id field's value.
func (*SecurityProfileSummary) SetName ¶ added in v1.15.2
func (s *SecurityProfileSummary) SetName(v string) *SecurityProfileSummary
SetName sets the Name field's value.
func (SecurityProfileSummary) String ¶ added in v1.15.2
func (s SecurityProfileSummary) String() string
String returns the string representation
type StartOutboundVoiceContactInput ¶
type StartOutboundVoiceContactInput struct { // Specify a custom key-value pair using an attribute map. The attributes are // standard Amazon Connect attributes, and can be accessed in contact flows // just like any other contact attributes. // // There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute // keys can include only alphanumeric, dash, and underscore characters. // // For example, if you want play a greeting when the customer answers the call, // you can pass the customer name in attributes similar to the following: Attributes map[string]*string `type:"map"` // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. The token is valid for 7 days after creation. If a contact // is already started, the contact ID is returned. If the contact is disconnected, // a new contact is started. ClientToken *string `type:"string" idempotencyToken:"true"` // The identifier for the contact flow to connect the outbound call to. // // To find the ContactFlowId, open the contact flow you want to use in the Amazon // Connect contact flow editor. The ID for the contact flow is displayed in // the address bar as part of the URL. For example, the contact flow ID is the // set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b. // // ContactFlowId is a required field ContactFlowId *string `type:"string" required:"true"` // The phone number of the customer in E.164 format. // // DestinationPhoneNumber is a required field DestinationPhoneNumber *string `type:"string" required:"true"` // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `min:"1" type:"string" required:"true"` // The queue to add the call to. If you specify a queue, the phone displayed // for caller ID is the phone number specified in the queue. If you do not specify // a queue, the queue used will be the queue defined in the contact flow. // // To find the QueueId, open the queue you want to use in the Amazon Connect // Queue editor. The ID for the queue is displayed in the address bar as part // of the URL. For example, the queue ID is the set of characters at the end // of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c. QueueId *string `type:"string"` // The phone number, in E.164 format, associated with your Amazon Connect instance // to use for the outbound call. SourcePhoneNumber *string `type:"string"` // contains filtered or unexported fields }
func (StartOutboundVoiceContactInput) GoString ¶
func (s StartOutboundVoiceContactInput) GoString() string
GoString returns the string representation
func (*StartOutboundVoiceContactInput) SetAttributes ¶
func (s *StartOutboundVoiceContactInput) SetAttributes(v map[string]*string) *StartOutboundVoiceContactInput
SetAttributes sets the Attributes field's value.
func (*StartOutboundVoiceContactInput) SetClientToken ¶
func (s *StartOutboundVoiceContactInput) SetClientToken(v string) *StartOutboundVoiceContactInput
SetClientToken sets the ClientToken field's value.
func (*StartOutboundVoiceContactInput) SetContactFlowId ¶
func (s *StartOutboundVoiceContactInput) SetContactFlowId(v string) *StartOutboundVoiceContactInput
SetContactFlowId sets the ContactFlowId field's value.
func (*StartOutboundVoiceContactInput) SetDestinationPhoneNumber ¶
func (s *StartOutboundVoiceContactInput) SetDestinationPhoneNumber(v string) *StartOutboundVoiceContactInput
SetDestinationPhoneNumber sets the DestinationPhoneNumber field's value.
func (*StartOutboundVoiceContactInput) SetInstanceId ¶
func (s *StartOutboundVoiceContactInput) SetInstanceId(v string) *StartOutboundVoiceContactInput
SetInstanceId sets the InstanceId field's value.
func (*StartOutboundVoiceContactInput) SetQueueId ¶
func (s *StartOutboundVoiceContactInput) SetQueueId(v string) *StartOutboundVoiceContactInput
SetQueueId sets the QueueId field's value.
func (*StartOutboundVoiceContactInput) SetSourcePhoneNumber ¶
func (s *StartOutboundVoiceContactInput) SetSourcePhoneNumber(v string) *StartOutboundVoiceContactInput
SetSourcePhoneNumber sets the SourcePhoneNumber field's value.
func (StartOutboundVoiceContactInput) String ¶
func (s StartOutboundVoiceContactInput) String() string
String returns the string representation
func (*StartOutboundVoiceContactInput) Validate ¶
func (s *StartOutboundVoiceContactInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartOutboundVoiceContactOutput ¶
type StartOutboundVoiceContactOutput struct { // The unique identifier of this contact within your Amazon Connect instance. ContactId *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (StartOutboundVoiceContactOutput) GoString ¶
func (s StartOutboundVoiceContactOutput) GoString() string
GoString returns the string representation
func (*StartOutboundVoiceContactOutput) SetContactId ¶
func (s *StartOutboundVoiceContactOutput) SetContactId(v string) *StartOutboundVoiceContactOutput
SetContactId sets the ContactId field's value.
func (StartOutboundVoiceContactOutput) String ¶
func (s StartOutboundVoiceContactOutput) String() string
String returns the string representation
type StopContactInput ¶
type StopContactInput struct { // The unique identifier of the contact to end. // // ContactId is a required field ContactId *string `min:"1" type:"string" required:"true"` // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (StopContactInput) GoString ¶
func (s StopContactInput) GoString() string
GoString returns the string representation
func (*StopContactInput) SetContactId ¶
func (s *StopContactInput) SetContactId(v string) *StopContactInput
SetContactId sets the ContactId field's value.
func (*StopContactInput) SetInstanceId ¶
func (s *StopContactInput) SetInstanceId(v string) *StopContactInput
SetInstanceId sets the InstanceId field's value.
func (StopContactInput) String ¶
func (s StopContactInput) String() string
String returns the string representation
func (*StopContactInput) Validate ¶
func (s *StopContactInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopContactOutput ¶
type StopContactOutput struct {
// contains filtered or unexported fields
}
func (StopContactOutput) GoString ¶
func (s StopContactOutput) GoString() string
GoString returns the string representation
func (StopContactOutput) String ¶
func (s StopContactOutput) String() string
String returns the string representation
type UpdateUserHierarchyInput ¶ added in v1.15.2
type UpdateUserHierarchyInput struct { // The identifier for the hierarchy group to assign to the user. HierarchyGroupId *string `type:"string"` // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifier of the user account to assign the hierarchy group to. // // UserId is a required field UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateUserHierarchyInput) GoString ¶ added in v1.15.2
func (s UpdateUserHierarchyInput) GoString() string
GoString returns the string representation
func (*UpdateUserHierarchyInput) SetHierarchyGroupId ¶ added in v1.15.2
func (s *UpdateUserHierarchyInput) SetHierarchyGroupId(v string) *UpdateUserHierarchyInput
SetHierarchyGroupId sets the HierarchyGroupId field's value.
func (*UpdateUserHierarchyInput) SetInstanceId ¶ added in v1.15.2
func (s *UpdateUserHierarchyInput) SetInstanceId(v string) *UpdateUserHierarchyInput
SetInstanceId sets the InstanceId field's value.
func (*UpdateUserHierarchyInput) SetUserId ¶ added in v1.15.2
func (s *UpdateUserHierarchyInput) SetUserId(v string) *UpdateUserHierarchyInput
SetUserId sets the UserId field's value.
func (UpdateUserHierarchyInput) String ¶ added in v1.15.2
func (s UpdateUserHierarchyInput) String() string
String returns the string representation
func (*UpdateUserHierarchyInput) Validate ¶ added in v1.15.2
func (s *UpdateUserHierarchyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUserHierarchyOutput ¶ added in v1.15.2
type UpdateUserHierarchyOutput struct {
// contains filtered or unexported fields
}
func (UpdateUserHierarchyOutput) GoString ¶ added in v1.15.2
func (s UpdateUserHierarchyOutput) GoString() string
GoString returns the string representation
func (UpdateUserHierarchyOutput) String ¶ added in v1.15.2
func (s UpdateUserHierarchyOutput) String() string
String returns the string representation
type UpdateUserIdentityInfoInput ¶ added in v1.15.2
type UpdateUserIdentityInfoInput struct { // A UserIdentityInfo object. // // IdentityInfo is a required field IdentityInfo *UserIdentityInfo `type:"structure" required:"true"` // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifier for the user account to update identity information for. // // UserId is a required field UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateUserIdentityInfoInput) GoString ¶ added in v1.15.2
func (s UpdateUserIdentityInfoInput) GoString() string
GoString returns the string representation
func (*UpdateUserIdentityInfoInput) SetIdentityInfo ¶ added in v1.15.2
func (s *UpdateUserIdentityInfoInput) SetIdentityInfo(v *UserIdentityInfo) *UpdateUserIdentityInfoInput
SetIdentityInfo sets the IdentityInfo field's value.
func (*UpdateUserIdentityInfoInput) SetInstanceId ¶ added in v1.15.2
func (s *UpdateUserIdentityInfoInput) SetInstanceId(v string) *UpdateUserIdentityInfoInput
SetInstanceId sets the InstanceId field's value.
func (*UpdateUserIdentityInfoInput) SetUserId ¶ added in v1.15.2
func (s *UpdateUserIdentityInfoInput) SetUserId(v string) *UpdateUserIdentityInfoInput
SetUserId sets the UserId field's value.
func (UpdateUserIdentityInfoInput) String ¶ added in v1.15.2
func (s UpdateUserIdentityInfoInput) String() string
String returns the string representation
func (*UpdateUserIdentityInfoInput) Validate ¶ added in v1.15.2
func (s *UpdateUserIdentityInfoInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUserIdentityInfoOutput ¶ added in v1.15.2
type UpdateUserIdentityInfoOutput struct {
// contains filtered or unexported fields
}
func (UpdateUserIdentityInfoOutput) GoString ¶ added in v1.15.2
func (s UpdateUserIdentityInfoOutput) GoString() string
GoString returns the string representation
func (UpdateUserIdentityInfoOutput) String ¶ added in v1.15.2
func (s UpdateUserIdentityInfoOutput) String() string
String returns the string representation
type UpdateUserPhoneConfigInput ¶ added in v1.15.2
type UpdateUserPhoneConfigInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit, // AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user. // // PhoneConfig is a required field PhoneConfig *UserPhoneConfig `type:"structure" required:"true"` // The identifier for the user account to change phone settings for. // // UserId is a required field UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateUserPhoneConfigInput) GoString ¶ added in v1.15.2
func (s UpdateUserPhoneConfigInput) GoString() string
GoString returns the string representation
func (*UpdateUserPhoneConfigInput) SetInstanceId ¶ added in v1.15.2
func (s *UpdateUserPhoneConfigInput) SetInstanceId(v string) *UpdateUserPhoneConfigInput
SetInstanceId sets the InstanceId field's value.
func (*UpdateUserPhoneConfigInput) SetPhoneConfig ¶ added in v1.15.2
func (s *UpdateUserPhoneConfigInput) SetPhoneConfig(v *UserPhoneConfig) *UpdateUserPhoneConfigInput
SetPhoneConfig sets the PhoneConfig field's value.
func (*UpdateUserPhoneConfigInput) SetUserId ¶ added in v1.15.2
func (s *UpdateUserPhoneConfigInput) SetUserId(v string) *UpdateUserPhoneConfigInput
SetUserId sets the UserId field's value.
func (UpdateUserPhoneConfigInput) String ¶ added in v1.15.2
func (s UpdateUserPhoneConfigInput) String() string
String returns the string representation
func (*UpdateUserPhoneConfigInput) Validate ¶ added in v1.15.2
func (s *UpdateUserPhoneConfigInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUserPhoneConfigOutput ¶ added in v1.15.2
type UpdateUserPhoneConfigOutput struct {
// contains filtered or unexported fields
}
func (UpdateUserPhoneConfigOutput) GoString ¶ added in v1.15.2
func (s UpdateUserPhoneConfigOutput) GoString() string
GoString returns the string representation
func (UpdateUserPhoneConfigOutput) String ¶ added in v1.15.2
func (s UpdateUserPhoneConfigOutput) String() string
String returns the string representation
type UpdateUserRoutingProfileInput ¶ added in v1.15.2
type UpdateUserRoutingProfileInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifier of the routing profile to assign to the user. // // RoutingProfileId is a required field RoutingProfileId *string `type:"string" required:"true"` // The identifier for the user account to assign the routing profile to. // // UserId is a required field UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateUserRoutingProfileInput) GoString ¶ added in v1.15.2
func (s UpdateUserRoutingProfileInput) GoString() string
GoString returns the string representation
func (*UpdateUserRoutingProfileInput) SetInstanceId ¶ added in v1.15.2
func (s *UpdateUserRoutingProfileInput) SetInstanceId(v string) *UpdateUserRoutingProfileInput
SetInstanceId sets the InstanceId field's value.
func (*UpdateUserRoutingProfileInput) SetRoutingProfileId ¶ added in v1.15.2
func (s *UpdateUserRoutingProfileInput) SetRoutingProfileId(v string) *UpdateUserRoutingProfileInput
SetRoutingProfileId sets the RoutingProfileId field's value.
func (*UpdateUserRoutingProfileInput) SetUserId ¶ added in v1.15.2
func (s *UpdateUserRoutingProfileInput) SetUserId(v string) *UpdateUserRoutingProfileInput
SetUserId sets the UserId field's value.
func (UpdateUserRoutingProfileInput) String ¶ added in v1.15.2
func (s UpdateUserRoutingProfileInput) String() string
String returns the string representation
func (*UpdateUserRoutingProfileInput) Validate ¶ added in v1.15.2
func (s *UpdateUserRoutingProfileInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUserRoutingProfileOutput ¶ added in v1.15.2
type UpdateUserRoutingProfileOutput struct {
// contains filtered or unexported fields
}
func (UpdateUserRoutingProfileOutput) GoString ¶ added in v1.15.2
func (s UpdateUserRoutingProfileOutput) GoString() string
GoString returns the string representation
func (UpdateUserRoutingProfileOutput) String ¶ added in v1.15.2
func (s UpdateUserRoutingProfileOutput) String() string
String returns the string representation
type UpdateUserSecurityProfilesInput ¶ added in v1.15.2
type UpdateUserSecurityProfilesInput struct { // The identifier for your Amazon Connect instance. To find the ID of your instance, // open the AWS console and select Amazon Connect. Select the alias of the instance // in the Instance alias column. The instance ID is displayed in the Overview // section of your instance settings. For example, the instance ID is the set // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` // The identifiers for the security profiles to assign to the user. // // SecurityProfileIds is a required field SecurityProfileIds []*string `min:"1" type:"list" required:"true"` // The identifier of the user account to assign the security profiles. // // UserId is a required field UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateUserSecurityProfilesInput) GoString ¶ added in v1.15.2
func (s UpdateUserSecurityProfilesInput) GoString() string
GoString returns the string representation
func (*UpdateUserSecurityProfilesInput) SetInstanceId ¶ added in v1.15.2
func (s *UpdateUserSecurityProfilesInput) SetInstanceId(v string) *UpdateUserSecurityProfilesInput
SetInstanceId sets the InstanceId field's value.
func (*UpdateUserSecurityProfilesInput) SetSecurityProfileIds ¶ added in v1.15.2
func (s *UpdateUserSecurityProfilesInput) SetSecurityProfileIds(v []*string) *UpdateUserSecurityProfilesInput
SetSecurityProfileIds sets the SecurityProfileIds field's value.
func (*UpdateUserSecurityProfilesInput) SetUserId ¶ added in v1.15.2
func (s *UpdateUserSecurityProfilesInput) SetUserId(v string) *UpdateUserSecurityProfilesInput
SetUserId sets the UserId field's value.
func (UpdateUserSecurityProfilesInput) String ¶ added in v1.15.2
func (s UpdateUserSecurityProfilesInput) String() string
String returns the string representation
func (*UpdateUserSecurityProfilesInput) Validate ¶ added in v1.15.2
func (s *UpdateUserSecurityProfilesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUserSecurityProfilesOutput ¶ added in v1.15.2
type UpdateUserSecurityProfilesOutput struct {
// contains filtered or unexported fields
}
func (UpdateUserSecurityProfilesOutput) GoString ¶ added in v1.15.2
func (s UpdateUserSecurityProfilesOutput) GoString() string
GoString returns the string representation
func (UpdateUserSecurityProfilesOutput) String ¶ added in v1.15.2
func (s UpdateUserSecurityProfilesOutput) String() string
String returns the string representation
type User ¶ added in v1.15.2
type User struct { // The ARN of the user account. Arn *string `type:"string"` // The directory Id for the user account in the existing directory used for // identity management. DirectoryUserId *string `type:"string"` // The identifier for the hierarchy group assigned to the user. HierarchyGroupId *string `type:"string"` // The identifier of the user account. Id *string `type:"string"` // A UserIdentityInfo object. IdentityInfo *UserIdentityInfo `type:"structure"` // A UserPhoneConfig object. PhoneConfig *UserPhoneConfig `type:"structure"` // The identifier of the routing profile assigned to the user. RoutingProfileId *string `type:"string"` // The identifier(s) for the security profile assigned to the user. SecurityProfileIds []*string `min:"1" type:"list"` // The user name assigned to the user account. Username *string `min:"1" type:"string"` // contains filtered or unexported fields }
A User object that contains information about a user account in your Amazon Connect instance, including configuration settings.
func (*User) SetDirectoryUserId ¶ added in v1.15.2
SetDirectoryUserId sets the DirectoryUserId field's value.
func (*User) SetHierarchyGroupId ¶ added in v1.15.2
SetHierarchyGroupId sets the HierarchyGroupId field's value.
func (*User) SetIdentityInfo ¶ added in v1.15.2
func (s *User) SetIdentityInfo(v *UserIdentityInfo) *User
SetIdentityInfo sets the IdentityInfo field's value.
func (*User) SetPhoneConfig ¶ added in v1.15.2
func (s *User) SetPhoneConfig(v *UserPhoneConfig) *User
SetPhoneConfig sets the PhoneConfig field's value.
func (*User) SetRoutingProfileId ¶ added in v1.15.2
SetRoutingProfileId sets the RoutingProfileId field's value.
func (*User) SetSecurityProfileIds ¶ added in v1.15.2
SetSecurityProfileIds sets the SecurityProfileIds field's value.
func (*User) SetUsername ¶ added in v1.15.2
SetUsername sets the Username field's value.
type UserIdentityInfo ¶ added in v1.15.2
type UserIdentityInfo struct { // The email address added to the user account. If you are using SAML for identity // management and include this parameter, an InvalidRequestException is returned. Email *string `type:"string"` // The first name used in the user account. This is required if you are using // Amazon Connect or SAML for identity management. FirstName *string `min:"1" type:"string"` // The last name used in the user account. This is required if you are using // Amazon Connect or SAML for identity management. LastName *string `min:"1" type:"string"` // contains filtered or unexported fields }
A UserIdentityInfo object that contains information about the user's identity, including email address, first name, and last name.
func (UserIdentityInfo) GoString ¶ added in v1.15.2
func (s UserIdentityInfo) GoString() string
GoString returns the string representation
func (*UserIdentityInfo) SetEmail ¶ added in v1.15.2
func (s *UserIdentityInfo) SetEmail(v string) *UserIdentityInfo
SetEmail sets the Email field's value.
func (*UserIdentityInfo) SetFirstName ¶ added in v1.15.2
func (s *UserIdentityInfo) SetFirstName(v string) *UserIdentityInfo
SetFirstName sets the FirstName field's value.
func (*UserIdentityInfo) SetLastName ¶ added in v1.15.2
func (s *UserIdentityInfo) SetLastName(v string) *UserIdentityInfo
SetLastName sets the LastName field's value.
func (UserIdentityInfo) String ¶ added in v1.15.2
func (s UserIdentityInfo) String() string
String returns the string representation
func (*UserIdentityInfo) Validate ¶ added in v1.15.2
func (s *UserIdentityInfo) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UserPhoneConfig ¶ added in v1.15.2
type UserPhoneConfig struct { // The After Call Work (ACW) timeout setting, in seconds, for the user. AfterContactWorkTimeLimit *int64 `type:"integer"` // The Auto accept setting for the user, Yes or No. AutoAccept *bool `type:"boolean"` // The phone number for the user's desk phone. DeskPhoneNumber *string `type:"string"` // The phone type selected for the user, either Soft phone or Desk phone. // // PhoneType is a required field PhoneType *string `type:"string" required:"true" enum:"PhoneType"` // contains filtered or unexported fields }
A UserPhoneConfig object that contains information about the user phone configuration settings.
func (UserPhoneConfig) GoString ¶ added in v1.15.2
func (s UserPhoneConfig) GoString() string
GoString returns the string representation
func (*UserPhoneConfig) SetAfterContactWorkTimeLimit ¶ added in v1.15.2
func (s *UserPhoneConfig) SetAfterContactWorkTimeLimit(v int64) *UserPhoneConfig
SetAfterContactWorkTimeLimit sets the AfterContactWorkTimeLimit field's value.
func (*UserPhoneConfig) SetAutoAccept ¶ added in v1.15.2
func (s *UserPhoneConfig) SetAutoAccept(v bool) *UserPhoneConfig
SetAutoAccept sets the AutoAccept field's value.
func (*UserPhoneConfig) SetDeskPhoneNumber ¶ added in v1.15.2
func (s *UserPhoneConfig) SetDeskPhoneNumber(v string) *UserPhoneConfig
SetDeskPhoneNumber sets the DeskPhoneNumber field's value.
func (*UserPhoneConfig) SetPhoneType ¶ added in v1.15.2
func (s *UserPhoneConfig) SetPhoneType(v string) *UserPhoneConfig
SetPhoneType sets the PhoneType field's value.
func (UserPhoneConfig) String ¶ added in v1.15.2
func (s UserPhoneConfig) String() string
String returns the string representation
func (*UserPhoneConfig) Validate ¶ added in v1.15.2
func (s *UserPhoneConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UserSummary ¶ added in v1.15.2
type UserSummary struct { // The ARN for the user account. Arn *string `type:"string"` // The identifier for the user account. Id *string `type:"string"` // The Amazon Connect user name for the user account. Username *string `min:"1" type:"string"` // contains filtered or unexported fields }
A UserSummary object that contains Information about a user, including ARN, Id, and user name.
func (UserSummary) GoString ¶ added in v1.15.2
func (s UserSummary) GoString() string
GoString returns the string representation
func (*UserSummary) SetArn ¶ added in v1.15.2
func (s *UserSummary) SetArn(v string) *UserSummary
SetArn sets the Arn field's value.
func (*UserSummary) SetId ¶ added in v1.15.2
func (s *UserSummary) SetId(v string) *UserSummary
SetId sets the Id field's value.
func (*UserSummary) SetUsername ¶ added in v1.15.2
func (s *UserSummary) SetUsername(v string) *UserSummary
SetUsername sets the Username field's value.
func (UserSummary) String ¶ added in v1.15.2
func (s UserSummary) String() string
String returns the string representation
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. |