AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateUserInput

import "github.com/aws/aws-sdk-go/service/connect"

type CreateUserInput struct { DirectoryUserId *string `type:"string"` HierarchyGroupId *string `type:"string"` IdentityInfo *UserIdentityInfo `type:"structure"` InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` Password *string `type:"string"` PhoneConfig *UserPhoneConfig `type:"structure" required:"true"` RoutingProfileId *string `type:"string" required:"true"` SecurityProfileIds []*string `min:"1" type:"list" required:"true"` Username *string `min:"1" type:"string" required:"true"` }

DirectoryUserId

Type: *string

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.

HierarchyGroupId

Type: *string

The unique identifier for the hierarchy group to assign to the user created.

IdentityInfo

A UserIdentityInfo object that contains information about the user's identity, including email address, first name, and last name.

InstanceId

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

Password

Type: *string

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.

PhoneConfig

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

RoutingProfileId

Type: *string

The unique identifier for the routing profile to assign to the user created.

RoutingProfileId is a required field

SecurityProfileIds

Type: []*string

The unique identifier of the security profile to assign to the user created.

SecurityProfileIds is a required field

Username

Type: *string

The user name in Amazon Connect for the account to create. If you are using SAML for identity management in your Amazon Connect, the value for Username can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Username is a required field

Method

GoString

func (s CreateUserInput) GoString() string

GoString returns the string representation

SetDirectoryUserId

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

SetDirectoryUserId sets the DirectoryUserId field's value.

SetHierarchyGroupId

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

SetHierarchyGroupId sets the HierarchyGroupId field's value.

SetIdentityInfo

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

SetIdentityInfo sets the IdentityInfo field's value.

SetInstanceId

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

SetInstanceId sets the InstanceId field's value.

SetPassword

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

SetPassword sets the Password field's value.

SetPhoneConfig

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

SetPhoneConfig sets the PhoneConfig field's value.

SetRoutingProfileId

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

SetRoutingProfileId sets the RoutingProfileId field's value.

SetSecurityProfileIds

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

SetSecurityProfileIds sets the SecurityProfileIds field's value.

SetUsername

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

SetUsername sets the Username field's value.

String

func (s CreateUserInput) String() string

String returns the string representation

Validate

func (s *CreateUserInput) Validate() error

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

On this page: