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
|
// 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/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Describes the customizations associated with the provided Amazon Web Services
// account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
// The Amazon QuickSight console evaluates which customizations to apply by running
// this API operation with the Resolved flag included. To determine what
// customizations display when you run this command, it can help to visualize the
// relationship of the entities involved.
// - Amazon Web Services account - The Amazon Web Services account exists at the
// top of the hierarchy. It has the potential to use all of the Amazon Web Services
// Regions and Amazon Web Services Services. When you subscribe to Amazon
// QuickSight, you choose one Amazon Web Services Region to use as your home
// Region. That's where your free SPICE capacity is located. You can use Amazon
// QuickSight in any supported Amazon Web Services Region.
// - Amazon Web Services Region - In each Amazon Web Services Region where you
// sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate
// instance of the same service. If you have a user directory, it resides in
// us-east-1, which is the US East (N. Virginia). Generally speaking, these users
// have access to Amazon QuickSight in any Amazon Web Services Region, unless they
// are constrained to a namespace. To run the command in a different Amazon Web
// Services Region, you change your Region settings. If you're using the CLI, you
// can use one of the following options:
// - Use command line options (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html)
// .
// - Use named profiles (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html)
// .
// - Run aws configure to change your default Amazon Web Services Region. Use
// Enter to key the same settings for your keys. For more information, see
// Configuring the CLI (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
// .
// - Namespace - A QuickSight namespace is a partition that contains users and
// assets (data sources, datasets, dashboards, and so on). To access assets that
// are in a specific namespace, users and groups must also be part of the same
// namespace. People who share a namespace are completely isolated from users and
// assets in other namespaces, even if they are in the same Amazon Web Services
// account and Amazon Web Services Region.
// - Applied customizations - Within an Amazon Web Services Region, a set of
// Amazon QuickSight customizations can apply to an Amazon Web Services account or
// to a namespace. Settings that you apply to a namespace override settings that
// you apply to an Amazon Web Services account. All settings are isolated to a
// single Amazon Web Services Region. To apply them in other Amazon Web Services
// Regions, run the CreateAccountCustomization command in each Amazon Web
// Services Region where you want to apply the same customizations.
func (c *Client) DescribeAccountCustomization(ctx context.Context, params *DescribeAccountCustomizationInput, optFns ...func(*Options)) (*DescribeAccountCustomizationOutput, error) {
if params == nil {
params = &DescribeAccountCustomizationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeAccountCustomization", params, optFns, c.addOperationDescribeAccountCustomizationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeAccountCustomizationOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeAccountCustomizationInput struct {
// The ID for the Amazon Web Services account that you want to describe Amazon
// QuickSight customizations for.
//
// This member is required.
AwsAccountId *string
// The Amazon QuickSight namespace that you want to describe Amazon QuickSight
// customizations for.
Namespace *string
// The Resolved flag works with the other parameters to determine which view of
// Amazon QuickSight customizations is returned. You can add this flag to your
// command to use the same view that Amazon QuickSight uses to identify which
// customizations to apply to the console. Omit this flag, or set it to no-resolved
// , to reveal customizations that are configured at different levels.
Resolved bool
noSmithyDocumentSerde
}
type DescribeAccountCustomizationOutput struct {
// The Amazon QuickSight customizations that exist in the current Amazon Web
// Services Region.
AccountCustomization *types.AccountCustomization
// The Amazon Resource Name (ARN) of the customization that's associated with this
// Amazon Web Services account.
Arn *string
// The ID for the Amazon Web Services account that you're describing.
AwsAccountId *string
// The Amazon QuickSight namespace that you're describing.
Namespace *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeAccountCustomizationMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeAccountCustomization{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeAccountCustomization{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeAccountCustomization"); 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 = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.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 = addOpDescribeAccountCustomizationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeAccountCustomization(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.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_opDescribeAccountCustomization(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeAccountCustomization",
}
}
|