Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.QuickSight.CreateAccountCustomization

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

Synopsis

Creating a Request

data CreateAccountCustomization Source #

See: newCreateAccountCustomization smart constructor.

Constructors

CreateAccountCustomization'

Fields

namespace :: Maybe Text
The Amazon QuickSight namespace that you want to add customizations to.
tags :: Maybe (NonEmpty Tag)
A list of the tags that you want to attach to this resource.
awsAccountId :: Text
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
accountCustomization :: AccountCustomization
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a Amazon QuickSight namespace.
For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.

Instances

Instances details

Eq CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods (==) :: CreateAccountCustomization -> CreateAccountCustomization -> Bool # (/=) :: CreateAccountCustomization -> CreateAccountCustomization -> Bool #
Read CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods readsPrec :: Int -> ReadS CreateAccountCustomization # readList :: ReadS [CreateAccountCustomization] # readPrec :: ReadPrec CreateAccountCustomization # readListPrec :: ReadPrec [CreateAccountCustomization] #
Show CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods showsPrec :: Int -> CreateAccountCustomization -> ShowS # show :: CreateAccountCustomization -> String # showList :: [CreateAccountCustomization] -> ShowS #
Generic CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Associated Types type Rep CreateAccountCustomization :: Type -> Type # Methods from :: CreateAccountCustomization -> Rep CreateAccountCustomization x # to :: Rep CreateAccountCustomization x -> CreateAccountCustomization #
NFData CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods rnf :: CreateAccountCustomization -> () #
Hashable CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods hashWithSalt :: Int -> CreateAccountCustomization -> Int # hash :: CreateAccountCustomization -> Int #
ToJSON CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods toJSON :: CreateAccountCustomization -> Value # toEncoding :: CreateAccountCustomization -> Encoding # toJSONList :: [CreateAccountCustomization] -> Value # toEncodingList :: [CreateAccountCustomization] -> Encoding #
AWSRequest CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Associated Types type AWSResponse CreateAccountCustomization # Methods request :: CreateAccountCustomization -> Request CreateAccountCustomization # response :: MonadResource m => Logger -> Service -> Proxy CreateAccountCustomization -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAccountCustomization))) #
ToHeaders CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods toHeaders :: CreateAccountCustomization -> [Header] #
ToPath CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods toPath :: CreateAccountCustomization -> ByteString #
ToQuery CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods toQuery :: CreateAccountCustomization -> QueryString #
type Rep CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization type Rep CreateAccountCustomization = D1 ('MetaData "CreateAccountCustomization" "Amazonka.QuickSight.CreateAccountCustomization" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "CreateAccountCustomization'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accountCustomization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccountCustomization))))
type AWSResponse CreateAccountCustomization Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization type AWSResponse CreateAccountCustomization = CreateAccountCustomizationResponse

newCreateAccountCustomization Source #

Arguments

:: Text	`$sel:awsAccountId:CreateAccountCustomization'`
-> AccountCustomization	`$sel:accountCustomization:CreateAccountCustomization'`
-> CreateAccountCustomization

Create a value of CreateAccountCustomization with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:namespace:CreateAccountCustomization', createAccountCustomization_namespace - The Amazon QuickSight namespace that you want to add customizations to.

$sel:tags:CreateAccountCustomization', createAccountCustomization_tags - A list of the tags that you want to attach to this resource.

$sel:awsAccountId:CreateAccountCustomization', createAccountCustomization_awsAccountId - The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

$sel:accountCustomization:CreateAccountCustomization', createAccountCustomization_accountCustomization - The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a Amazon QuickSight namespace.

For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.

Request Lenses

createAccountCustomization_namespace :: Lens' CreateAccountCustomization (Maybe Text) Source #

The Amazon QuickSight namespace that you want to add customizations to.

createAccountCustomization_tags :: Lens' CreateAccountCustomization (Maybe (NonEmpty Tag)) Source #

A list of the tags that you want to attach to this resource.

createAccountCustomization_awsAccountId :: Lens' CreateAccountCustomization Text Source #

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

createAccountCustomization_accountCustomization :: Lens' CreateAccountCustomization AccountCustomization Source #

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a Amazon QuickSight namespace.

For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.

Destructuring the Response

data CreateAccountCustomizationResponse Source #

See: newCreateAccountCustomizationResponse smart constructor.

Constructors

CreateAccountCustomizationResponse'

Fields

requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
accountCustomization :: Maybe AccountCustomization
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.
arn :: Maybe Text
The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.
namespace :: Maybe Text
The namespace associated with the customization you're creating.
awsAccountId :: Maybe Text
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
status :: Int
The HTTP status of the request.

Instances

Instances details

Eq CreateAccountCustomizationResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods (==) :: CreateAccountCustomizationResponse -> CreateAccountCustomizationResponse -> Bool # (/=) :: CreateAccountCustomizationResponse -> CreateAccountCustomizationResponse -> Bool #
Read CreateAccountCustomizationResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods readsPrec :: Int -> ReadS CreateAccountCustomizationResponse # readList :: ReadS [CreateAccountCustomizationResponse] # readPrec :: ReadPrec CreateAccountCustomizationResponse # readListPrec :: ReadPrec [CreateAccountCustomizationResponse] #
Show CreateAccountCustomizationResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods showsPrec :: Int -> CreateAccountCustomizationResponse -> ShowS # show :: CreateAccountCustomizationResponse -> String # showList :: [CreateAccountCustomizationResponse] -> ShowS #
Generic CreateAccountCustomizationResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Associated Types type Rep CreateAccountCustomizationResponse :: Type -> Type # Methods from :: CreateAccountCustomizationResponse -> Rep CreateAccountCustomizationResponse x # to :: Rep CreateAccountCustomizationResponse x -> CreateAccountCustomizationResponse #
NFData CreateAccountCustomizationResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization Methods rnf :: CreateAccountCustomizationResponse -> () #
type Rep CreateAccountCustomizationResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountCustomization type Rep CreateAccountCustomizationResponse = D1 ('MetaData "CreateAccountCustomizationResponse" "Amazonka.QuickSight.CreateAccountCustomization" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "CreateAccountCustomizationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "accountCustomization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccountCustomization)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateAccountCustomizationResponse Source #

Arguments

:: Int	`$sel:status:CreateAccountCustomizationResponse'`
-> CreateAccountCustomizationResponse

Create a value of CreateAccountCustomizationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:CreateAccountCustomizationResponse', createAccountCustomizationResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:accountCustomization:CreateAccountCustomization', createAccountCustomizationResponse_accountCustomization - The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

$sel:arn:CreateAccountCustomizationResponse', createAccountCustomizationResponse_arn - The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

$sel:namespace:CreateAccountCustomization', createAccountCustomizationResponse_namespace - The namespace associated with the customization you're creating.

$sel:awsAccountId:CreateAccountCustomization', createAccountCustomizationResponse_awsAccountId - The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

$sel:status:CreateAccountCustomizationResponse', createAccountCustomizationResponse_status - The HTTP status of the request.

Response Lenses

createAccountCustomizationResponse_requestId :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createAccountCustomizationResponse_accountCustomization :: Lens' CreateAccountCustomizationResponse (Maybe AccountCustomization) Source #

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

createAccountCustomizationResponse_arn :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

createAccountCustomizationResponse_namespace :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The namespace associated with the customization you're creating.

createAccountCustomizationResponse_awsAccountId :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

createAccountCustomizationResponse_status :: Lens' CreateAccountCustomizationResponse Int Source #

The HTTP status of the request.