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.CreateDashboard

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

Synopsis

data CreateDashboard = CreateDashboard' {
- dashboardPublishOptions :: Maybe DashboardPublishOptions
- definition :: Maybe DashboardVersionDefinition
- parameters :: Maybe Parameters
- permissions :: Maybe (NonEmpty ResourcePermission)
- sourceEntity :: Maybe DashboardSourceEntity
- tags :: Maybe (NonEmpty Tag)
- themeArn :: Maybe Text
- versionDescription :: Maybe Text
- awsAccountId :: Text
- dashboardId :: Text
- name :: Text
}
newCreateDashboard :: Text -> Text -> Text -> CreateDashboard
createDashboard_dashboardPublishOptions :: Lens' CreateDashboard (Maybe DashboardPublishOptions)
createDashboard_definition :: Lens' CreateDashboard (Maybe DashboardVersionDefinition)
createDashboard_parameters :: Lens' CreateDashboard (Maybe Parameters)
createDashboard_permissions :: Lens' CreateDashboard (Maybe (NonEmpty ResourcePermission))
createDashboard_sourceEntity :: Lens' CreateDashboard (Maybe DashboardSourceEntity)
createDashboard_tags :: Lens' CreateDashboard (Maybe (NonEmpty Tag))
createDashboard_themeArn :: Lens' CreateDashboard (Maybe Text)
createDashboard_versionDescription :: Lens' CreateDashboard (Maybe Text)
createDashboard_awsAccountId :: Lens' CreateDashboard Text
createDashboard_dashboardId :: Lens' CreateDashboard Text
createDashboard_name :: Lens' CreateDashboard Text
data CreateDashboardResponse = CreateDashboardResponse' {
- arn :: Maybe Text
- creationStatus :: Maybe ResourceStatus
- dashboardId :: Maybe Text
- requestId :: Maybe Text
- versionArn :: Maybe Text
- status :: Int
}
newCreateDashboardResponse :: Int -> CreateDashboardResponse
createDashboardResponse_arn :: Lens' CreateDashboardResponse (Maybe Text)
createDashboardResponse_creationStatus :: Lens' CreateDashboardResponse (Maybe ResourceStatus)
createDashboardResponse_dashboardId :: Lens' CreateDashboardResponse (Maybe Text)
createDashboardResponse_requestId :: Lens' CreateDashboardResponse (Maybe Text)
createDashboardResponse_versionArn :: Lens' CreateDashboardResponse (Maybe Text)
createDashboardResponse_status :: Lens' CreateDashboardResponse Int

Creating a Request

data CreateDashboard Source #

See: newCreateDashboard smart constructor.

Constructors

CreateDashboard'

Fields

dashboardPublishOptions :: Maybe DashboardPublishOptions
Options for publishing the dashboard when you create it:
- AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
- AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
- VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
definition :: Maybe DashboardVersionDefinition
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
parameters :: Maybe Parameters
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
permissions :: Maybe (NonEmpty ResourcePermission)
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
sourceEntity :: Maybe DashboardSourceEntity
The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
tags :: Maybe (NonEmpty Tag)
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
themeArn :: Maybe Text
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
versionDescription :: Maybe Text
A description for the first version of the dashboard being created.
awsAccountId :: Text
The ID of the Amazon Web Services account where you want to create the dashboard.
dashboardId :: Text
The ID for the dashboard, also added to the IAM policy.
name :: Text
The display name of the dashboard.

Instances

Instances details

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

newCreateDashboard Source #

Arguments

:: Text	`CreateDashboard`
-> Text	`CreateDashboard`
-> Text	`CreateDashboard`
-> CreateDashboard

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

$sel:dashboardPublishOptions:CreateDashboard', createDashboard_dashboardPublishOptions - Options for publishing the dashboard when you create it:

AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

$sel:definition:CreateDashboard', createDashboard_definition - The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

$sel:parameters:CreateDashboard', createDashboard_parameters - The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

CreateDashboard, createDashboard_permissions - A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

$sel:sourceEntity:CreateDashboard', createDashboard_sourceEntity - The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

CreateDashboard, createDashboard_tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

CreateDashboard, createDashboard_themeArn - The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

$sel:versionDescription:CreateDashboard', createDashboard_versionDescription - A description for the first version of the dashboard being created.

CreateDashboard, createDashboard_awsAccountId - The ID of the Amazon Web Services account where you want to create the dashboard.

CreateDashboard, createDashboard_dashboardId - The ID for the dashboard, also added to the IAM policy.

CreateDashboard, createDashboard_name - The display name of the dashboard.

Request Lenses

createDashboard_dashboardPublishOptions :: Lens' CreateDashboard (Maybe DashboardPublishOptions) Source #

Options for publishing the dashboard when you create it:

AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

createDashboard_definition :: Lens' CreateDashboard (Maybe DashboardVersionDefinition) Source #

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

createDashboard_parameters :: Lens' CreateDashboard (Maybe Parameters) Source #

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

createDashboard_permissions :: Lens' CreateDashboard (Maybe (NonEmpty ResourcePermission)) Source #

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

createDashboard_sourceEntity :: Lens' CreateDashboard (Maybe DashboardSourceEntity) Source #

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

createDashboard_tags :: Lens' CreateDashboard (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

createDashboard_themeArn :: Lens' CreateDashboard (Maybe Text) Source #

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

createDashboard_versionDescription :: Lens' CreateDashboard (Maybe Text) Source #

A description for the first version of the dashboard being created.

createDashboard_awsAccountId :: Lens' CreateDashboard Text Source #

The ID of the Amazon Web Services account where you want to create the dashboard.

createDashboard_dashboardId :: Lens' CreateDashboard Text Source #

The ID for the dashboard, also added to the IAM policy.

createDashboard_name :: Lens' CreateDashboard Text Source #

The display name of the dashboard.

Destructuring the Response

data CreateDashboardResponse Source #

See: newCreateDashboardResponse smart constructor.

Constructors

CreateDashboardResponse'

Fields

arn :: Maybe Text
The ARN of the dashboard.
creationStatus :: Maybe ResourceStatus
The status of the dashboard creation request.
dashboardId :: Maybe Text
The ID for the dashboard.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
versionArn :: Maybe Text
The ARN of the dashboard, including the version number of the first version that is created.
status :: Int
The HTTP status of the request.

Instances

Instances details

Generic CreateDashboardResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDashboard Associated Types type Rep CreateDashboardResponse :: Type -> Type # Methods from :: CreateDashboardResponse -> Rep CreateDashboardResponse x # to :: Rep CreateDashboardResponse x -> CreateDashboardResponse #
Read CreateDashboardResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDashboard Methods readsPrec :: Int -> ReadS CreateDashboardResponse # readList :: ReadS [CreateDashboardResponse] # readPrec :: ReadPrec CreateDashboardResponse # readListPrec :: ReadPrec [CreateDashboardResponse] #
Show CreateDashboardResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDashboard Methods showsPrec :: Int -> CreateDashboardResponse -> ShowS # show :: CreateDashboardResponse -> String # showList :: [CreateDashboardResponse] -> ShowS #
NFData CreateDashboardResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDashboard Methods rnf :: CreateDashboardResponse -> () #
Eq CreateDashboardResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDashboard Methods (==) :: CreateDashboardResponse -> CreateDashboardResponse -> Bool # (/=) :: CreateDashboardResponse -> CreateDashboardResponse -> Bool #
type Rep CreateDashboardResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDashboard type Rep CreateDashboardResponse = D1 ('MetaData "CreateDashboardResponse" "Amazonka.QuickSight.CreateDashboard" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateDashboardResponse'" '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 "dashboardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "requestId") '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)))))

newCreateDashboardResponse Source #

Arguments

:: Int	`CreateDashboardResponse`
-> CreateDashboardResponse

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

CreateDashboardResponse, createDashboardResponse_arn - The ARN of the dashboard.

CreateDashboardResponse, createDashboardResponse_creationStatus - The status of the dashboard creation request.

CreateDashboard, createDashboardResponse_dashboardId - The ID for the dashboard.

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

$sel:versionArn:CreateDashboardResponse', createDashboardResponse_versionArn - The ARN of the dashboard, including the version number of the first version that is created.

CreateDashboardResponse, createDashboardResponse_status - The HTTP status of the request.

Response Lenses

createDashboardResponse_arn :: Lens' CreateDashboardResponse (Maybe Text) Source #

The ARN of the dashboard.

createDashboardResponse_creationStatus :: Lens' CreateDashboardResponse (Maybe ResourceStatus) Source #

The status of the dashboard creation request.

createDashboardResponse_dashboardId :: Lens' CreateDashboardResponse (Maybe Text) Source #

The ID for the dashboard.

createDashboardResponse_requestId :: Lens' CreateDashboardResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createDashboardResponse_versionArn :: Lens' CreateDashboardResponse (Maybe Text) Source #

The ARN of the dashboard, including the version number of the first version that is created.

createDashboardResponse_status :: Lens' CreateDashboardResponse Int Source #

The HTTP status of the request.