Class: Aws::QuickSight::Types::CreateAccountSubscriptionRequest

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::CreateAccountSubscriptionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_name ⇒ String

  The name of your Amazon QuickSight account.

• #active_directory_name ⇒ String

  The name of your Active Directory.

• #admin_group ⇒ Array<String>

  The admin group associated with your Active Directory or IAM Identity Center account.

• #admin_pro_group ⇒ Array<String>

  The admin pro group associated with your Active Directory or IAM Identity Center account.

• #authentication_method ⇒ String

  The method that you want to use to authenticate your Amazon QuickSight account.

• #author_group ⇒ Array<String>

  The author group associated with your Active Directory or IAM Identity Center account.

• #author_pro_group ⇒ Array<String>

  The author pro group associated with your Active Directory or IAM Identity Center account.

• #aws_account_id ⇒ String

  The Amazon Web Services account ID of the account that you’re using to create your Amazon QuickSight account.

• #contact_number ⇒ String

  A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications.

• #directory_id ⇒ String

  The ID of the Active Directory that is associated with your Amazon QuickSight account.

• #edition ⇒ String

  The edition of Amazon QuickSight that you want your account to have.

• #email_address ⇒ String

  The email address of the author of the Amazon QuickSight account to use for future communications.

• #first_name ⇒ String

  The first name of the author of the Amazon QuickSight account to use for future communications.

• #iam_identity_center_instance_arn ⇒ String

  The Amazon Resource Name (ARN) for the IAM Identity Center instance.

• #last_name ⇒ String

  The last name of the author of the Amazon QuickSight account to use for future communications.

• #notification_email ⇒ String

  The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

• #reader_group ⇒ Array<String>

  The reader group associated with your Active Directory or IAM Identity Center account.

• #reader_pro_group ⇒ Array<String>

  The reader pro group associated with your Active Directory or IAM Identity Center account.

• #realm ⇒ String

  The realm of the Active Directory that is associated with your Amazon QuickSight account.

Instance Attribute Details

#account_name ⇒ String

The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can’t change ‘AccountName` value after the Amazon QuickSight account is created.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#active_directory_name ⇒ String

The name of your Active Directory. This field is required if ‘ACTIVE_DIRECTORY` is the selected authentication method of the new Amazon QuickSight account.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#admin_group ⇒ Array<String>

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the ‘AdminProGroup` field is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the selected authentication method of the new Amazon QuickSight account.

For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide.

[1]: docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html [2]: docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#admin_pro_group ⇒ Array<String>

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the ‘AdminGroup` field is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the selected authentication method of the new Amazon QuickSight account.

For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide.

[1]: docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html [2]: docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_method ⇒ String

The method that you want to use to authenticate your Amazon QuickSight account.

If you choose ‘ACTIVE_DIRECTORY`, provide an `ActiveDirectoryName` and an `AdminGroup` associated with your Active Directory.

If you choose ‘IAM_IDENTITY_CENTER`, provide an `AdminGroup` associated with your IAM Identity Center account.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#author_group ⇒ Array<String>

The author group associated with your Active Directory or IAM Identity Center account.

For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide.

[1]: docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html [2]: docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#author_pro_group ⇒ Array<String>

The author pro group associated with your Active Directory or IAM Identity Center account.

For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide.

[1]: docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html [2]: docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_id ⇒ String

The Amazon Web Services account ID of the account that you’re using to create your Amazon QuickSight account.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#contact_number ⇒ String

A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ‘ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#directory_id ⇒ String

The ID of the Active Directory that is associated with your Amazon QuickSight account.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#edition ⇒ String

The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ‘ENTERPRISE` or `ENTERPRISE_AND_Q`.

If you choose ‘ENTERPRISE_AND_Q`, the following parameters are required:

• ‘FirstName`

• ‘LastName`

• ‘EmailAddress`

• ‘ContactNumber`

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#email_address ⇒ String

The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ‘ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#first_name ⇒ String

The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ‘ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#iam_identity_center_instance_arn ⇒ String

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_name ⇒ String

The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ‘ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#notification_email ⇒ String

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#reader_group ⇒ Array<String>

The reader group associated with your Active Directory or IAM Identity Center account.

For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide.

[1]: docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html [2]: docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#reader_pro_group ⇒ Array<String>

The reader pro group associated with your Active Directory or IAM Identity Center account.

For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition] in the Amazon QuickSight User Guide.

[1]: docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html [2]: docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#realm ⇒ String

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ‘ACTIVE_DIRECTORY` is the selected authentication method of the new Amazon QuickSight account.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5107

class CreateAccountSubscriptionRequest < Struct.new(
  :edition,
  :authentication_method,
  :aws_account_id,
  :account_name,
  :notification_email,
  :active_directory_name,
  :realm,
  :directory_id,
  :admin_group,
  :author_group,
  :reader_group,
  :admin_pro_group,
  :author_pro_group,
  :reader_pro_group,
  :first_name,
  :last_name,
  :email_address,
  :contact_number,
  :iam_identity_center_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end