java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.quicksight.model.QuickSightRequest
    - - software.amazon.awssdk.services.quicksight.model.CreateAccountSubscriptionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAccountSubscriptionRequest
extends QuickSightRequest
implements ToCopyableBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateAccountSubscriptionRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accountName()`	The name of your QuickSight account.
`String`	`activeDirectoryName()`	The name of your Active Directory.
`List<String>`	`adminGroup()`	The admin group associated with your Active Directory or IAM Identity Center account.
`List<String>`	`adminProGroup()`	The admin pro group associated with your Active Directory or IAM Identity Center account.
`AuthenticationMethodOption`	`authenticationMethod()`	The method that you want to use to authenticate your QuickSight account.
`String`	`authenticationMethodAsString()`	The method that you want to use to authenticate your QuickSight account.
`List<String>`	`authorGroup()`	The author group associated with your Active Directory or IAM Identity Center account.
`List<String>`	`authorProGroup()`	The author pro group associated with your Active Directory or IAM Identity Center account.
`String`	`awsAccountId()`	The Amazon Web Services account ID of the account that you're using to create your QuickSight account.
`static CreateAccountSubscriptionRequest.Builder`	`builder()`
`String`	`contactNumber()`	A 10-digit phone number for the author of the QuickSight account to use for future communications.
`String`	`directoryId()`	The ID of the Active Directory that is associated with your QuickSight account.
`Edition`	`edition()`	The edition of QuickSight that you want your account to have.
`String`	`editionAsString()`	The edition of QuickSight that you want your account to have.
`String`	`emailAddress()`	The email address of the author of the QuickSight account to use for future communications.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`firstName()`	The first name of the author of the QuickSight account to use for future communications.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdminGroup()`	For responses, this returns true if the service returned a value for the AdminGroup property.
`boolean`	`hasAdminProGroup()`	For responses, this returns true if the service returned a value for the AdminProGroup property.
`boolean`	`hasAuthorGroup()`	For responses, this returns true if the service returned a value for the AuthorGroup property.
`boolean`	`hasAuthorProGroup()`	For responses, this returns true if the service returned a value for the AuthorProGroup property.
`int`	`hashCode()`
`boolean`	`hasReaderGroup()`	For responses, this returns true if the service returned a value for the ReaderGroup property.
`boolean`	`hasReaderProGroup()`	For responses, this returns true if the service returned a value for the ReaderProGroup property.
`String`	`iamIdentityCenterInstanceArn()`	The Amazon Resource Name (ARN) for the IAM Identity Center instance.
`String`	`lastName()`	The last name of the author of the QuickSight account to use for future communications.
`String`	`notificationEmail()`	The email address that you want QuickSight to send notifications to regarding your QuickSight account or QuickSight subscription.
`List<String>`	`readerGroup()`	The reader group associated with your Active Directory or IAM Identity Center account.
`List<String>`	`readerProGroup()`	The reader pro group associated with your Active Directory or IAM Identity Center account.
`String`	`realm()`	The realm of the Active Directory that is associated with your QuickSight account.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateAccountSubscriptionRequest.Builder>`	`serializableBuilderClass()`
`CreateAccountSubscriptionRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - edition
```
public final Edition edition()
```
    The edition of 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
    
    If the service returns an enum value that is not available in the current SDK version, edition will return Edition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from editionAsString().
    Returns:
    
    The edition of 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
    
    See Also:
    
    Edition
  - editionAsString
```
public final String editionAsString()
```
    The edition of 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
    
    If the service returns an enum value that is not available in the current SDK version, edition will return Edition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from editionAsString().
    Returns:
    
    The edition of 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
    
    See Also:
    
    Edition
  - authenticationMethod
```
public final AuthenticationMethodOption authenticationMethod()
```
    The method that you want to use to authenticate your 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.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationMethod will return AuthenticationMethodOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationMethodAsString().
    
    Returns:
    
    The method that you want to use to authenticate your 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.
    
    See Also:
    
    AuthenticationMethodOption
  - authenticationMethodAsString
```
public final String authenticationMethodAsString()
```
    The method that you want to use to authenticate your 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.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationMethod will return AuthenticationMethodOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationMethodAsString().
    
    Returns:
    
    The method that you want to use to authenticate your 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.
    
    See Also:
    
    AuthenticationMethodOption
  - awsAccountId
```
public final String awsAccountId()
```
    The Amazon Web Services account ID of the account that you're using to create your QuickSight account.
    
    Returns:
    
    The Amazon Web Services account ID of the account that you're using to create your QuickSight account.
  - accountName
```
public final String accountName()
```
    The name of your 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 QuickSight account is created.
    
    Returns:
    
    The name of your 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 QuickSight account is created.
  - notificationEmail
```
public final String notificationEmail()
```
    The email address that you want QuickSight to send notifications to regarding your QuickSight account or QuickSight subscription.
    
    Returns:
    
    The email address that you want QuickSight to send notifications to regarding your QuickSight account or QuickSight subscription.
  - activeDirectoryName
```
public final String activeDirectoryName()
```
    The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new QuickSight account.
    
    Returns:
    
    The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new QuickSight account.
  - realm
```
public final String realm()
```
    The realm of the Active Directory that is associated with your QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new QuickSight account.
    
    Returns:
    
    The realm of the Active Directory that is associated with your QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new QuickSight account.
  - directoryId
```
public final String directoryId()
```
    The ID of the Active Directory that is associated with your QuickSight account.
    
    Returns:
    
    The ID of the Active Directory that is associated with your QuickSight account.
  - hasAdminGroup
```
public final boolean hasAdminGroup()
```
    For responses, this returns true if the service returned a value for the AdminGroup property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - adminGroup
```
public final List<String> adminGroup()
```
    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 QuickSight account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdminGroup() method.
    
    Returns:
    
    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 QuickSight account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
  - hasAuthorGroup
```
public final boolean hasAuthorGroup()
```
    For responses, this returns true if the service returned a value for the AuthorGroup property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - authorGroup
```
public final List<String> authorGroup()
```
    The author group associated with your Active Directory or IAM Identity Center account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuthorGroup() method.
    
    Returns:
    
    The author group associated with your Active Directory or IAM Identity Center account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
  - hasReaderGroup
```
public final boolean hasReaderGroup()
```
    For responses, this returns true if the service returned a value for the ReaderGroup property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - readerGroup
```
public final List<String> readerGroup()
```
    The reader group associated with your Active Directory or IAM Identity Center account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReaderGroup() method.
    
    Returns:
    
    The reader group associated with your Active Directory or IAM Identity Center account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
  - hasAdminProGroup
```
public final boolean hasAdminProGroup()
```
    For responses, this returns true if the service returned a value for the AdminProGroup property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - adminProGroup
```
public final List<String> adminProGroup()
```
    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 QuickSight account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdminProGroup() method.
    
    Returns:
    
    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 QuickSight account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
  - hasAuthorProGroup
```
public final boolean hasAuthorProGroup()
```
    For responses, this returns true if the service returned a value for the AuthorProGroup property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - authorProGroup
```
public final List<String> authorProGroup()
```
    The author pro group associated with your Active Directory or IAM Identity Center account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuthorProGroup() method.
    
    Returns:
    
    The author pro group associated with your Active Directory or IAM Identity Center account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
  - hasReaderProGroup
```
public final boolean hasReaderProGroup()
```
    For responses, this returns true if the service returned a value for the ReaderProGroup property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - readerProGroup
```
public final List<String> readerProGroup()
```
    The reader pro group associated with your Active Directory or IAM Identity Center account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReaderProGroup() method.
    
    Returns:
    
    The reader pro group associated with your Active Directory or IAM Identity Center account.
    
    For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
  - firstName
```
public final String firstName()
```
    The first name of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.
    
    Returns:
    
    The first name of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.
  - lastName
```
public final String lastName()
```
    The last name of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.
    
    Returns:
    
    The last name of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.
  - emailAddress
```
public final String emailAddress()
```
    The email address of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.
    
    Returns:
    
    The email address of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.
  - contactNumber
```
public final String contactNumber()
```
    A 10-digit phone number for the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.
    
    Returns:
    
    A 10-digit phone number for the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.
  - iamIdentityCenterInstanceArn
```
public final String iamIdentityCenterInstanceArn()
```
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
  - toBuilder
```
public CreateAccountSubscriptionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>
    
    Specified by:
    
    toBuilder in class QuickSightRequest
  - builder
```
public static CreateAccountSubscriptionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateAccountSubscriptionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateAccountSubscriptionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

edition

editionAsString

authenticationMethod

authenticationMethodAsString

awsAccountId

accountName

notificationEmail

activeDirectoryName

realm

directoryId

hasAdminGroup

adminGroup

hasAuthorGroup

authorGroup

hasReaderGroup

readerGroup

hasAdminProGroup

adminProGroup

hasAuthorProGroup

authorProGroup

hasReaderProGroup

readerProGroup

firstName

lastName

emailAddress

contactNumber

iamIdentityCenterInstanceArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField