AWS API Changes

2020/09/08 - Amazon QuickSight - 3 updated api methods

Changes Update quicksight client to latest version

CreateAccountCustomization (updated)

Link ¶
Changes (request, response)
Request

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Response

{'Arn': 'string'}

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 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 won't be visible to your users even if you use this API operation to make it the default theme.

See also: AWS API Documentation

Request Syntax

client.create_account_customization(
    AwsAccountId='string',
    Namespace='string',
    AccountCustomization={
        'DefaultTheme': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

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

type Namespace:

string

param Namespace:

The QuickSight namespace that you want to add customizations to.

type AccountCustomization:

dict

param AccountCustomization:

[REQUIRED]

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 could add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. ``. Or, you could 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.

type Tags:

list

param Tags:

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

(dict) --

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
- Key (string) -- [REQUIRED]
  
  Tag key.
- Value (string) -- [REQUIRED]
  
  Tag value.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'AwsAccountId': 'string',
    'Namespace': 'string',
    'AccountCustomization': {
        'DefaultTheme': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- 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 (dict) --
  
  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.

DescribeAccountCustomization (updated)

Link ¶
Changes (response)

{'Arn': 'string'}

Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The 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.

AWS Account - The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region.
AWS Region - In each AWS Region where you sign in to QuickSight at least once, 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 QuickSight in any AWS Region, unless they are constrained to a namespace. To run the command in a different AWS Region, you change your region settings. If you're using the AWS CLI, you can use one of the following options:
- Use command line options.
- Use named profiles.
- Run aws configure to change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI.
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 AWS account and AWS Region.
Applied customizations - Within an AWS Region, a set of QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS Account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the CreateAccountCustomization command in each AWS Region where you want to apply the same customizations.

See also: AWS API Documentation

Request Syntax

client.describe_account_customization(
    AwsAccountId='string',
    Namespace='string',
    Resolved=True|False
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

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

type Namespace:

string

param Namespace:

The QuickSight namespace that you want to describe QuickSight customizations for.

type Resolved:

boolean

param Resolved:

The Resolved flag works with the other parameters to determine which view of QuickSight customizations is returned. You can add this flag to your command to use the same view that 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.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'AwsAccountId': 'string',
    'Namespace': 'string',
    'AccountCustomization': {
        'DefaultTheme': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.
- AwsAccountId (string) --
  
  The ID for the AWS account that you're describing.
- Namespace (string) --
  
  The QuickSight namespace that you're describing.
- AccountCustomization (dict) --
  
  The QuickSight customizations that exist 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.

UpdateAccountCustomization (updated)

Link ¶
Changes (response)

{'Arn': 'string'}

Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.

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