/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Quicksight::RegisterUser

NAME

Paws::Quicksight::RegisterUser - Arguments for method RegisterUser on Paws::Quicksight

DESCRIPTION

This class represents the parameters used for calling the method RegisterUser on the Amazon QuickSight service. Use the attributes of this class as arguments to method RegisterUser.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterUser.

SYNOPSIS

my $quicksight = Paws->service('Quicksight');
my $RegisterUserResponse = $quicksight->RegisterUser(
  AwsAccountId                        => 'MyAwsAccountId',
  Email                               => 'MyString',
  IdentityType                        => 'IAM',
  Namespace                           => 'MyNamespace',
  UserRole                            => 'ADMIN',
  CustomFederationProviderUrl         => 'MyString',             # OPTIONAL
  CustomPermissionsName               => 'MyRoleName',           # OPTIONAL
  ExternalLoginFederationProviderType => 'MyString',             # OPTIONAL
  ExternalLoginId                     => 'MyString',             # OPTIONAL
  IamArn                              => 'MyString',             # OPTIONAL
  SessionName                         => 'MyRoleSessionName',    # OPTIONAL
  UserName                            => 'MyUserName',           # OPTIONAL
);

# Results:
my $RequestId         = $RegisterUserResponse->RequestId;
my $Status            = $RegisterUserResponse->Status;
my $User              = $RegisterUserResponse->User;
my $UserInvitationUrl = $RegisterUserResponse->UserInvitationUrl;

# Returns a L<Paws::Quicksight::RegisterUserResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/quicksight/RegisterUser

ATTRIBUTES

REQUIRED AwsAccountId => Str

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.

CustomFederationProviderUrl => Str

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into QuickSight with an associated AWS Identity and Access Management (IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

CustomPermissionsName => Str

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

To add custom permissions to an existing user, use UpdateUser instead.

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).

This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

REQUIRED Email => Str

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

ExternalLoginFederationProviderType => Str

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated AWS Identity and Access Management (IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

ExternalLoginId => Str

The identity ID for a user in the external login provider.

IamArn => Str

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

REQUIRED IdentityType => Str

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.

Valid values are: "IAM", "QUICKSIGHT"

REQUIRED Namespace => Str

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

SessionName => Str

You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user 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 => Str

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

REQUIRED UserRole => Str

The Amazon QuickSight role for 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, datasets, analyses, and dashboards.

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

  • RESTRICTED_READER: This role isn't currently available for use.

  • RESTRICTED_AUTHOR: This role isn't currently available for use.

Valid values are: "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"

SEE ALSO

This class forms part of Paws, documenting arguments for method RegisterUser in Paws::Quicksight

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues