Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

create-account-customization

Description

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

You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an AWS 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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-account-customization
--aws-account-id <value>
[--namespace <value>]
--account-customization <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID for the AWS account that you want to customize QuickSight for.

--namespace (string)

The QuickSight namespace that you want to add customizations to.

--account-customization (structure)

The QuickSight customizations you're adding in the current AWS Region. You can add these to an AWS account and a 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" } .

DefaultTheme -> (string)

The default theme for this QuickSight subscription.

Shorthand Syntax:

DefaultTheme=string

JSON Syntax:

{
  "DefaultTheme": "string"
}

--tags (list)

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

(structure)

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

Key -> (string)

Tag key.

Value -> (string)

Tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Arn -> (string)

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

AwsAccountId -> (string)

The ID for the AWS account that you want to customize QuickSight for.

Namespace -> (string)

The namespace associated with the customization you're creating.

AccountCustomization -> (structure)

The QuickSight customizations you're adding in the current AWS Region.

DefaultTheme -> (string)

The default theme for this QuickSight subscription.

RequestId -> (string)

The AWS request ID for this operation.

Status -> (integer)

The HTTP status of the request.