1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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.
//
// 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.
//
// [Passing IAM roles to Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role
// [Setting default resource access to Amazon Web Services services]: https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html
// [Sign up for Amazon Web Services]: https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html
// [IAM Policy Examples for Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html
func (c *Client) CreateAccountSubscription(ctx context.Context, params *CreateAccountSubscriptionInput, optFns ...func(*Options)) (*CreateAccountSubscriptionOutput, error) {
if params == nil {
params = &CreateAccountSubscriptionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateAccountSubscription", params, optFns, c.addOperationCreateAccountSubscriptionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateAccountSubscriptionOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateAccountSubscriptionInput struct {
// 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.
//
// This member is required.
AccountName *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.
//
// This member is required.
AuthenticationMethod types.AuthenticationMethodOption
// The Amazon Web Services account ID of the account that you're using to create
// your Amazon QuickSight account.
//
// This member is required.
AwsAccountId *string
// The email address that you want Amazon QuickSight to send notifications to
// regarding your Amazon QuickSight account or Amazon QuickSight subscription.
//
// This member is required.
NotificationEmail *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.
ActiveDirectoryName *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.
//
// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
AdminGroup []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.
//
// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
AdminProGroup []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.
//
// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
AuthorGroup []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.
//
// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
AuthorProGroup []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.
ContactNumber *string
// The ID of the Active Directory that is associated with your Amazon QuickSight
// account.
DirectoryId *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
Edition types.Edition
// 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.
EmailAddress *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.
FirstName *string
// The Amazon Resource Name (ARN) for the IAM Identity Center instance.
IAMIdentityCenterInstanceArn *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.
LastName *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.
//
// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
ReaderGroup []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.
//
// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
ReaderProGroup []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.
Realm *string
noSmithyDocumentSerde
}
type CreateAccountSubscriptionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// A SignupResponse object that returns information about a newly created Amazon
// QuickSight account.
SignupResponse *types.SignupResponse
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateAccountSubscriptionMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateAccountSubscription{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateAccountSubscription{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateAccountSubscription"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpCreateAccountSubscriptionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateAccountSubscription(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateAccountSubscription(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateAccountSubscription",
}
}
|