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.

RegisterUserInput

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

type RegisterUserInput struct { AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` Email *string `type:"string" required:"true"` IamArn *string `type:"string"` IdentityType *string `type:"string" required:"true" enum:"IdentityType"` Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"` SessionName *string `type:"string"` UserName *string `min:"1" type:"string"` UserRole *string `type:"string" required:"true" enum:"UserRole"` }

AwsAccountId

Type: *string

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

AwsAccountId is a required field

Email

Type: *string

The email address of the user that you want to register.

Email is a required field

IamArn

Type: *string

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

IdentityType

Type: *string

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM: A user whose identity maps to an existing IAM user or role.

  • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

IdentityType is a required field

Namespace

Type: *string

The namespace. Currently, you should set this to default.

Namespace is a required field

SessionName

Type: *string

The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see assume-role (https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html) in the AWS CLI Reference.

UserName

Type: *string

The Amazon QuickSight user name that you want to create for the user you are registering.

UserRole

Type: *string

The Amazon QuickSight role of the user. The user role can be one of the following:

  • READER: A user who has read-only access to dashboards.

  • AUTHOR: A user who can create data sources, data sets, analyses, and dashboards.

  • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

UserRole is a required field

Method

GoString

func (s RegisterUserInput) GoString() string

GoString returns the string representation

SetAwsAccountId

func (s *RegisterUserInput) SetAwsAccountId(v string) *RegisterUserInput

SetAwsAccountId sets the AwsAccountId field's value.

SetEmail

func (s *RegisterUserInput) SetEmail(v string) *RegisterUserInput

SetEmail sets the Email field's value.

SetIamArn

func (s *RegisterUserInput) SetIamArn(v string) *RegisterUserInput

SetIamArn sets the IamArn field's value.

SetIdentityType

func (s *RegisterUserInput) SetIdentityType(v string) *RegisterUserInput

SetIdentityType sets the IdentityType field's value.

SetNamespace

func (s *RegisterUserInput) SetNamespace(v string) *RegisterUserInput

SetNamespace sets the Namespace field's value.

SetSessionName

func (s *RegisterUserInput) SetSessionName(v string) *RegisterUserInput

SetSessionName sets the SessionName field's value.

SetUserName

func (s *RegisterUserInput) SetUserName(v string) *RegisterUserInput

SetUserName sets the UserName field's value.

SetUserRole

func (s *RegisterUserInput) SetUserRole(v string) *RegisterUserInput

SetUserRole sets the UserRole field's value.

String

func (s RegisterUserInput) String() string

String returns the string representation

Validate

func (s *RegisterUserInput) Validate() error

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

On this page: