/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the quicksight-2018-04-01.normal.json service model. */ using System; using System.Collections.Generic; using System.Xml.Serialization; using System.Text; using System.IO; using System.Net; using Amazon.Runtime; using Amazon.Runtime.Internal; namespace Amazon.QuickSight.Model { /// /// Container for the parameters to the CreateAccountSubscription operation. /// Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. /// /// /// /// The Amazon Web Services Region for the account is derived from what is configured /// in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South /// America (Sao Paulo) Region, or Asia Pacific (Singapore) Region. /// /// /// /// Before you use this operation, make sure that you can connect to an existing Amazon /// Web Services account. If you don't have an Amazon Web Services account, see Sign /// up for Amazon Web Services in the Amazon QuickSight User Guide. The person /// who signs up for Amazon QuickSight needs to have the correct Identity and Access Management /// (IAM) permissions. For more information, see IAM /// Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide. /// /// /// /// If your IAM policy includes both the Subscribe and CreateAccountSubscription /// actions, make sure that both actions are set to Allow. If either action /// is set to Deny, the Deny action prevails and your API call /// fails. /// /// /// /// You can't pass an existing IAM role to access other Amazon Web Services services using /// this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing /// IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide. /// /// /// /// You can't set default resource access on the new account from the Amazon QuickSight /// API. Instead, add default resource access from the Amazon QuickSight console. For /// more information about setting default resource access to Amazon Web Services services, /// see Setting /// default resource access to Amazon Web Services services in the Amazon QuickSight /// User Guide. /// /// public partial class CreateAccountSubscriptionRequest : AmazonQuickSightRequest { private string _accountName; private string _activeDirectoryName; private List _adminGroup = new List(); private AuthenticationMethodOption _authenticationMethod; private List _authorGroup = new List(); private string _awsAccountId; private string _contactNumber; private string _directoryId; private Edition _edition; private string _emailAddress; private string _firstName; private string _lastName; private string _notificationEmail; private List _readerGroup = new List(); private string _realm; /// /// Gets and sets the property AccountName. /// /// 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. /// /// [AWSProperty(Required=true)] public string AccountName { get { return this._accountName; } set { this._accountName = value; } } // Check to see if AccountName property is set internal bool IsSetAccountName() { return this._accountName != null; } /// /// Gets and sets the property ActiveDirectoryName. /// /// The name of your Active Directory. This field is required if ACTIVE_DIRECTORY /// is the selected authentication method of the new Amazon QuickSight account. /// /// public string ActiveDirectoryName { get { return this._activeDirectoryName; } set { this._activeDirectoryName = value; } } // Check to see if ActiveDirectoryName property is set internal bool IsSetActiveDirectoryName() { return this._activeDirectoryName != null; } /// /// Gets and sets the property AdminGroup. /// /// The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY /// is the selected authentication method of the new Amazon QuickSight account. 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. /// /// public List AdminGroup { get { return this._adminGroup; } set { this._adminGroup = value; } } // Check to see if AdminGroup property is set internal bool IsSetAdminGroup() { return this._adminGroup != null && this._adminGroup.Count > 0; } /// /// Gets and sets the property AuthenticationMethod. /// /// The method that you want to use to authenticate your Amazon QuickSight account. Currently, /// the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, /// and ACTIVE_DIRECTORY. /// /// /// /// If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName /// and an AdminGroup associated with your Active Directory. /// /// [AWSProperty(Required=true)] public AuthenticationMethodOption AuthenticationMethod { get { return this._authenticationMethod; } set { this._authenticationMethod = value; } } // Check to see if AuthenticationMethod property is set internal bool IsSetAuthenticationMethod() { return this._authenticationMethod != null; } /// /// Gets and sets the property AuthorGroup. /// /// The author group associated with your Active Directory. 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. /// /// public List AuthorGroup { get { return this._authorGroup; } set { this._authorGroup = value; } } // Check to see if AuthorGroup property is set internal bool IsSetAuthorGroup() { return this._authorGroup != null && this._authorGroup.Count > 0; } /// /// Gets and sets the property AwsAccountId. /// /// The Amazon Web Services account ID of the account that you're using to create your /// Amazon QuickSight account. /// /// [AWSProperty(Required=true, Min=12, Max=12)] public string AwsAccountId { get { return this._awsAccountId; } set { this._awsAccountId = value; } } // Check to see if AwsAccountId property is set internal bool IsSetAwsAccountId() { return this._awsAccountId != null; } /// /// Gets and sets the property ContactNumber. /// /// 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. /// /// public string ContactNumber { get { return this._contactNumber; } set { this._contactNumber = value; } } // Check to see if ContactNumber property is set internal bool IsSetContactNumber() { return this._contactNumber != null; } /// /// Gets and sets the property DirectoryId. /// /// The ID of the Active Directory that is associated with your Amazon QuickSight account. /// /// public string DirectoryId { get { return this._directoryId; } set { this._directoryId = value; } } // Check to see if DirectoryId property is set internal bool IsSetDirectoryId() { return this._directoryId != null; } /// /// Gets and sets the property Edition. /// /// 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 /// ///
///
[AWSProperty(Required=true)] public Edition Edition { get { return this._edition; } set { this._edition = value; } } // Check to see if Edition property is set internal bool IsSetEdition() { return this._edition != null; } /// /// Gets and sets the property EmailAddress. /// /// 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. /// /// public string EmailAddress { get { return this._emailAddress; } set { this._emailAddress = value; } } // Check to see if EmailAddress property is set internal bool IsSetEmailAddress() { return this._emailAddress != null; } /// /// Gets and sets the property FirstName. /// /// 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. /// /// public string FirstName { get { return this._firstName; } set { this._firstName = value; } } // Check to see if FirstName property is set internal bool IsSetFirstName() { return this._firstName != null; } /// /// Gets and sets the property LastName. /// /// 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. /// /// public string LastName { get { return this._lastName; } set { this._lastName = value; } } // Check to see if LastName property is set internal bool IsSetLastName() { return this._lastName != null; } /// /// Gets and sets the property NotificationEmail. /// /// The email address that you want Amazon QuickSight to send notifications to regarding /// your Amazon QuickSight account or Amazon QuickSight subscription. /// /// [AWSProperty(Required=true)] public string NotificationEmail { get { return this._notificationEmail; } set { this._notificationEmail = value; } } // Check to see if NotificationEmail property is set internal bool IsSetNotificationEmail() { return this._notificationEmail != null; } /// /// Gets and sets the property ReaderGroup. /// /// The reader group associated with your Active Direcrtory. 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. /// /// public List ReaderGroup { get { return this._readerGroup; } set { this._readerGroup = value; } } // Check to see if ReaderGroup property is set internal bool IsSetReaderGroup() { return this._readerGroup != null && this._readerGroup.Count > 0; } /// /// Gets and sets the property Realm. /// /// 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. /// /// public string Realm { get { return this._realm; } set { this._realm = value; } } // Check to see if Realm property is set internal bool IsSetRealm() { return this._realm != null; } } }