Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.CreateTheme

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

Synopsis

data CreateTheme = CreateTheme' {
- permissions :: Maybe (NonEmpty ResourcePermission)
- tags :: Maybe (NonEmpty Tag)
- versionDescription :: Maybe Text
- awsAccountId :: Text
- themeId :: Text
- name :: Text
- baseThemeId :: Text
- configuration :: ThemeConfiguration
}
newCreateTheme :: Text -> Text -> Text -> Text -> ThemeConfiguration -> CreateTheme
createTheme_permissions :: Lens' CreateTheme (Maybe (NonEmpty ResourcePermission))
createTheme_tags :: Lens' CreateTheme (Maybe (NonEmpty Tag))
createTheme_versionDescription :: Lens' CreateTheme (Maybe Text)
createTheme_awsAccountId :: Lens' CreateTheme Text
createTheme_themeId :: Lens' CreateTheme Text
createTheme_name :: Lens' CreateTheme Text
createTheme_baseThemeId :: Lens' CreateTheme Text
createTheme_configuration :: Lens' CreateTheme ThemeConfiguration
data CreateThemeResponse = CreateThemeResponse' {
- arn :: Maybe Text
- creationStatus :: Maybe ResourceStatus
- requestId :: Maybe Text
- themeId :: Maybe Text
- versionArn :: Maybe Text
- status :: Int
}
newCreateThemeResponse :: Int -> CreateThemeResponse
createThemeResponse_arn :: Lens' CreateThemeResponse (Maybe Text)
createThemeResponse_creationStatus :: Lens' CreateThemeResponse (Maybe ResourceStatus)
createThemeResponse_requestId :: Lens' CreateThemeResponse (Maybe Text)
createThemeResponse_themeId :: Lens' CreateThemeResponse (Maybe Text)
createThemeResponse_versionArn :: Lens' CreateThemeResponse (Maybe Text)
createThemeResponse_status :: Lens' CreateThemeResponse Int

Creating a Request

data CreateTheme Source #

See: newCreateTheme smart constructor.

Constructors

CreateTheme'

Fields

permissions :: Maybe (NonEmpty ResourcePermission)
A valid grouping of resource permissions to apply to the new theme.
tags :: Maybe (NonEmpty Tag)
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
versionDescription :: Maybe Text
A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.
awsAccountId :: Text
The ID of the Amazon Web Services account where you want to store the new theme.
themeId :: Text
An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
name :: Text
A display name for the theme.
baseThemeId :: Text
The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.
configuration :: ThemeConfiguration
The theme configuration, which contains the theme display properties.

Instances

Instances details

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

newCreateTheme Source #

Arguments

:: Text	`CreateTheme`
-> Text	`CreateTheme`
-> Text	`CreateTheme`
-> Text	`CreateTheme`
-> ThemeConfiguration	`CreateTheme`
-> CreateTheme

Create a value of CreateTheme 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:

CreateTheme, createTheme_permissions - A valid grouping of resource permissions to apply to the new theme.

CreateTheme, createTheme_tags - A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

$sel:versionDescription:CreateTheme', createTheme_versionDescription - A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

CreateTheme, createTheme_awsAccountId - The ID of the Amazon Web Services account where you want to store the new theme.

CreateTheme, createTheme_themeId - An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

CreateTheme, createTheme_name - A display name for the theme.

CreateTheme, createTheme_baseThemeId - The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

CreateTheme, createTheme_configuration - The theme configuration, which contains the theme display properties.

Request Lenses

createTheme_permissions :: Lens' CreateTheme (Maybe (NonEmpty ResourcePermission)) Source #

A valid grouping of resource permissions to apply to the new theme.

createTheme_tags :: Lens' CreateTheme (Maybe (NonEmpty Tag)) Source #

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

createTheme_versionDescription :: Lens' CreateTheme (Maybe Text) Source #

A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

createTheme_awsAccountId :: Lens' CreateTheme Text Source #

The ID of the Amazon Web Services account where you want to store the new theme.

createTheme_themeId :: Lens' CreateTheme Text Source #

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

createTheme_name :: Lens' CreateTheme Text Source #

A display name for the theme.

createTheme_baseThemeId :: Lens' CreateTheme Text Source #

The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

createTheme_configuration :: Lens' CreateTheme ThemeConfiguration Source #

The theme configuration, which contains the theme display properties.

Destructuring the Response

data CreateThemeResponse Source #

See: newCreateThemeResponse smart constructor.

Constructors

CreateThemeResponse'
Fields arn :: Maybe Text The Amazon Resource Name (ARN) for the theme. creationStatus :: Maybe ResourceStatus The theme creation status. requestId :: Maybe Text The Amazon Web Services request ID for this operation. themeId :: Maybe Text The ID of the theme. versionArn :: Maybe Text The Amazon Resource Name (ARN) for the new theme. status :: Int The HTTP status of the request.

Instances

Instances details

Generic CreateThemeResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateTheme Associated Types type Rep CreateThemeResponse :: Type -> Type # Methods from :: CreateThemeResponse -> Rep CreateThemeResponse x # to :: Rep CreateThemeResponse x -> CreateThemeResponse #
Read CreateThemeResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateTheme Methods readsPrec :: Int -> ReadS CreateThemeResponse # readList :: ReadS [CreateThemeResponse] # readPrec :: ReadPrec CreateThemeResponse # readListPrec :: ReadPrec [CreateThemeResponse] #
Show CreateThemeResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateTheme Methods showsPrec :: Int -> CreateThemeResponse -> ShowS # show :: CreateThemeResponse -> String # showList :: [CreateThemeResponse] -> ShowS #
NFData CreateThemeResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateTheme Methods rnf :: CreateThemeResponse -> () #
Eq CreateThemeResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateTheme Methods (==) :: CreateThemeResponse -> CreateThemeResponse -> Bool # (/=) :: CreateThemeResponse -> CreateThemeResponse -> Bool #
type Rep CreateThemeResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateTheme type Rep CreateThemeResponse = D1 ('MetaData "CreateThemeResponse" "Amazonka.QuickSight.CreateTheme" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateThemeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceStatus)) :: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "themeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "versionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateThemeResponse Source #

Arguments

:: Int	`CreateThemeResponse`
-> CreateThemeResponse

Create a value of CreateThemeResponse 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:

CreateThemeResponse, createThemeResponse_arn - The Amazon Resource Name (ARN) for the theme.

CreateThemeResponse, createThemeResponse_creationStatus - The theme creation status.

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

CreateTheme, createThemeResponse_themeId - The ID of the theme.

$sel:versionArn:CreateThemeResponse', createThemeResponse_versionArn - The Amazon Resource Name (ARN) for the new theme.

CreateThemeResponse, createThemeResponse_status - The HTTP status of the request.

Response Lenses

createThemeResponse_arn :: Lens' CreateThemeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the theme.

createThemeResponse_creationStatus :: Lens' CreateThemeResponse (Maybe ResourceStatus) Source #

The theme creation status.

createThemeResponse_requestId :: Lens' CreateThemeResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createThemeResponse_themeId :: Lens' CreateThemeResponse (Maybe Text) Source #

The ID of the theme.

createThemeResponse_versionArn :: Lens' CreateThemeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the new theme.

createThemeResponse_status :: Lens' CreateThemeResponse Int Source #

The HTTP status of the request.