CreateBrand
Creates an Amazon QuickSight brand.
Request Syntax
POST /accounts/AwsAccountId/brands/BrandId HTTP/1.1
Content-type: application/json
{
"BrandDefinition": {
"ApplicationTheme": {
"BrandColorPalette": {
"Accent": {
"Background": "string",
"Foreground": "string"
},
"Danger": {
"Background": "string",
"Foreground": "string"
},
"Dimension": {
"Background": "string",
"Foreground": "string"
},
"Info": {
"Background": "string",
"Foreground": "string"
},
"Measure": {
"Background": "string",
"Foreground": "string"
},
"Primary": {
"Background": "string",
"Foreground": "string"
},
"Secondary": {
"Background": "string",
"Foreground": "string"
},
"Success": {
"Background": "string",
"Foreground": "string"
},
"Warning": {
"Background": "string",
"Foreground": "string"
}
},
"BrandElementStyle": {
"NavbarStyle": {
"ContextualNavbar": {
"Background": "string",
"Foreground": "string"
},
"GlobalNavbar": {
"Background": "string",
"Foreground": "string"
}
}
}
},
"BrandName": "string",
"Description": "string",
"LogoConfiguration": {
"AltText": "string",
"LogoSet": {
"Favicon": {
"Original": {
"Source": { ... }
}
},
"Primary": {
"Original": {
"Source": { ... }
}
}
}
}
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the AWS account that owns the brand.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
- BrandId
-
The ID of the Amazon QuickSight brand.
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- BrandDefinition
-
The definition of the brand.
Type: BrandDefinition object
Required: No
- Tags
-
A map of the key-value pairs that are assigned to the brand.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BrandDefinition": {
"ApplicationTheme": {
"BrandColorPalette": {
"Accent": {
"Background": "string",
"Foreground": "string"
},
"Danger": {
"Background": "string",
"Foreground": "string"
},
"Dimension": {
"Background": "string",
"Foreground": "string"
},
"Info": {
"Background": "string",
"Foreground": "string"
},
"Measure": {
"Background": "string",
"Foreground": "string"
},
"Primary": {
"Background": "string",
"Foreground": "string"
},
"Secondary": {
"Background": "string",
"Foreground": "string"
},
"Success": {
"Background": "string",
"Foreground": "string"
},
"Warning": {
"Background": "string",
"Foreground": "string"
}
},
"BrandElementStyle": {
"NavbarStyle": {
"ContextualNavbar": {
"Background": "string",
"Foreground": "string"
},
"GlobalNavbar": {
"Background": "string",
"Foreground": "string"
}
}
}
},
"BrandName": "string",
"Description": "string",
"LogoConfiguration": {
"AltText": "string",
"LogoSet": {
"Favicon": {
"Original": {
"Source": { ... }
}
},
"Primary": {
"Original": {
"Source": { ... }
}
}
}
}
},
"BrandDetail": {
"Arn": "string",
"BrandId": "string",
"BrandStatus": "string",
"CreatedTime": number,
"Errors": [ "string" ],
"LastUpdatedTime": number,
"Logo": {
"AltText": "string",
"LogoSet": {
"Favicon": {
"Height32": {
"GeneratedImageUrl": "string",
"Source": { ... }
},
"Height64": {
"GeneratedImageUrl": "string",
"Source": { ... }
},
"Original": {
"GeneratedImageUrl": "string",
"Source": { ... }
}
},
"Primary": {
"Height32": {
"GeneratedImageUrl": "string",
"Source": { ... }
},
"Height64": {
"GeneratedImageUrl": "string",
"Source": { ... }
},
"Original": {
"GeneratedImageUrl": "string",
"Source": { ... }
}
}
}
},
"VersionId": "string",
"VersionStatus": "string"
},
"RequestId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- BrandDefinition
-
The definition of the brand.
Type: BrandDefinition object
- BrandDetail
-
The details of the brand.
Type: BrandDetail object
- RequestId
-
The AWS request ID for this operation.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
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.
HTTP Status Code: 401
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
An internal service exception.
HTTP Status Code: 500
- InvalidRequestException
-
You don't have this feature activated for your account. To fix this issue, contact AWS support.
HTTP Status Code: 400
- LimitExceededException
-
A limit is exceeded.
HTTP Status Code: 409
- ThrottlingException
-
Access is throttled.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
