UpdateBrandCommand

Suggest an Edit

Updates a brand.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QuickSightClient, UpdateBrandCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, UpdateBrandCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // UpdateBrandRequest
  AwsAccountId: "STRING_VALUE", // required
  BrandId: "STRING_VALUE", // required
  BrandDefinition: { // BrandDefinition
    BrandName: "STRING_VALUE", // required
    Description: "STRING_VALUE",
    ApplicationTheme: { // ApplicationTheme
      BrandColorPalette: { // BrandColorPalette
        Primary: { // Palette
          Foreground: "STRING_VALUE",
          Background: "STRING_VALUE",
        },
        Secondary: {
          Foreground: "STRING_VALUE",
          Background: "STRING_VALUE",
        },
        Accent: {
          Foreground: "STRING_VALUE",
          Background: "STRING_VALUE",
        },
        Measure: {
          Foreground: "STRING_VALUE",
          Background: "STRING_VALUE",
        },
        Dimension: {
          Foreground: "STRING_VALUE",
          Background: "STRING_VALUE",
        },
        Success: "<Palette>",
        Info: "<Palette>",
        Warning: "<Palette>",
        Danger: "<Palette>",
      },
      BrandElementStyle: { // BrandElementStyle
        NavbarStyle: { // NavbarStyle
          GlobalNavbar: "<Palette>",
          ContextualNavbar: "<Palette>",
        },
      },
    },
    LogoConfiguration: { // LogoConfiguration
      AltText: "STRING_VALUE", // required
      LogoSet: { // LogoSetConfiguration
        Primary: { // ImageSetConfiguration
          Original: { // ImageConfiguration
            Source: { // ImageSource Union: only one key present
              PublicUrl: "STRING_VALUE",
              S3Uri: "STRING_VALUE",
            },
          },
        },
        Favicon: {
          Original: {
            Source: {//  Union: only one key present
              PublicUrl: "STRING_VALUE",
              S3Uri: "STRING_VALUE",
            },
          },
        },
      },
    },
  },
};
const command = new UpdateBrandCommand(input);
const response = await client.send(command);
// { // UpdateBrandResponse
//   RequestId: "STRING_VALUE",
//   BrandDetail: { // BrandDetail
//     BrandId: "STRING_VALUE", // required
//     Arn: "STRING_VALUE",
//     BrandStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
//     CreatedTime: new Date("TIMESTAMP"),
//     LastUpdatedTime: new Date("TIMESTAMP"),
//     VersionId: "STRING_VALUE",
//     VersionStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED",
//     Errors: [ // ErrorList
//       "STRING_VALUE",
//     ],
//     Logo: { // Logo
//       AltText: "STRING_VALUE", // required
//       LogoSet: { // LogoSet
//         Primary: { // ImageSet
//           Original: { // Image
//             Source: { // ImageSource Union: only one key present
//               PublicUrl: "STRING_VALUE",
//               S3Uri: "STRING_VALUE",
//             },
//             GeneratedImageUrl: "STRING_VALUE",
//           },
//           Height64: {
//             Source: {//  Union: only one key present
//               PublicUrl: "STRING_VALUE",
//               S3Uri: "STRING_VALUE",
//             },
//             GeneratedImageUrl: "STRING_VALUE",
//           },
//           Height32: {
//             Source: {//  Union: only one key present
//               PublicUrl: "STRING_VALUE",
//               S3Uri: "STRING_VALUE",
//             },
//             GeneratedImageUrl: "STRING_VALUE",
//           },
//         },
//         Favicon: {
//           Original: {
//             Source: {//  Union: only one key present
//               PublicUrl: "STRING_VALUE",
//               S3Uri: "STRING_VALUE",
//             },
//             GeneratedImageUrl: "STRING_VALUE",
//           },
//           Height64: {
//             Source: {//  Union: only one key present
//               PublicUrl: "STRING_VALUE",
//               S3Uri: "STRING_VALUE",
//             },
//             GeneratedImageUrl: "STRING_VALUE",
//           },
//           Height32: "<Image>",
//         },
//       },
//     },
//   },
//   BrandDefinition: { // BrandDefinition
//     BrandName: "STRING_VALUE", // required
//     Description: "STRING_VALUE",
//     ApplicationTheme: { // ApplicationTheme
//       BrandColorPalette: { // BrandColorPalette
//         Primary: { // Palette
//           Foreground: "STRING_VALUE",
//           Background: "STRING_VALUE",
//         },
//         Secondary: {
//           Foreground: "STRING_VALUE",
//           Background: "STRING_VALUE",
//         },
//         Accent: {
//           Foreground: "STRING_VALUE",
//           Background: "STRING_VALUE",
//         },
//         Measure: {
//           Foreground: "STRING_VALUE",
//           Background: "STRING_VALUE",
//         },
//         Dimension: {
//           Foreground: "STRING_VALUE",
//           Background: "STRING_VALUE",
//         },
//         Success: "<Palette>",
//         Info: "<Palette>",
//         Warning: "<Palette>",
//         Danger: "<Palette>",
//       },
//       BrandElementStyle: { // BrandElementStyle
//         NavbarStyle: { // NavbarStyle
//           GlobalNavbar: "<Palette>",
//           ContextualNavbar: "<Palette>",
//         },
//       },
//     },
//     LogoConfiguration: { // LogoConfiguration
//       AltText: "STRING_VALUE", // required
//       LogoSet: { // LogoSetConfiguration
//         Primary: { // ImageSetConfiguration
//           Original: { // ImageConfiguration
//             Source: "<ImageSource>",
//           },
//         },
//         Favicon: {
//           Original: {
//             Source: "<ImageSource>",
//           },
//         },
//       },
//     },
//   },
// };

UpdateBrandCommand Input

See UpdateBrandCommandInput for more details

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The ID of the Amazon Web Services account that owns the brand.

BrandId
Required
string | undefined

The ID of the Amazon QuickSight brand.

BrandDefinition
BrandDefinition | undefined

The definition of the brand.

UpdateBrandCommand Output

See UpdateBrandCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
BrandDefinition
BrandDefinition | undefined

The definition of the brand.

BrandDetail
BrandDetail | undefined

The details of the brand.

RequestId
string | undefined

The Amazon Web Services request ID for this operation.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

ConflictException
client

Updating or deleting a resource can cause an inconsistent state.

InternalServerException
server

An internal service exception.

InvalidRequestException
client

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

ResourceNotFoundException
client

One or more resources can't be found.

ThrottlingException
client

Access is throttled.

QuickSightServiceException
Base exception class for all service exceptions from QuickSight service.