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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

Synopsis

data UpdateDashboard = UpdateDashboard' {
- dashboardPublishOptions :: Maybe DashboardPublishOptions
- definition :: Maybe DashboardVersionDefinition
- parameters :: Maybe Parameters
- sourceEntity :: Maybe DashboardSourceEntity
- themeArn :: Maybe Text
- versionDescription :: Maybe Text
- awsAccountId :: Text
- dashboardId :: Text
- name :: Text
}
newUpdateDashboard :: Text -> Text -> Text -> UpdateDashboard
updateDashboard_dashboardPublishOptions :: Lens' UpdateDashboard (Maybe DashboardPublishOptions)
updateDashboard_definition :: Lens' UpdateDashboard (Maybe DashboardVersionDefinition)
updateDashboard_parameters :: Lens' UpdateDashboard (Maybe Parameters)
updateDashboard_sourceEntity :: Lens' UpdateDashboard (Maybe DashboardSourceEntity)
updateDashboard_themeArn :: Lens' UpdateDashboard (Maybe Text)
updateDashboard_versionDescription :: Lens' UpdateDashboard (Maybe Text)
updateDashboard_awsAccountId :: Lens' UpdateDashboard Text
updateDashboard_dashboardId :: Lens' UpdateDashboard Text
updateDashboard_name :: Lens' UpdateDashboard Text
data UpdateDashboardResponse = UpdateDashboardResponse' {
- arn :: Maybe Text
- creationStatus :: Maybe ResourceStatus
- dashboardId :: Maybe Text
- requestId :: Maybe Text
- status :: Maybe Int
- versionArn :: Maybe Text
- httpStatus :: Int
}
newUpdateDashboardResponse :: Int -> UpdateDashboardResponse
updateDashboardResponse_arn :: Lens' UpdateDashboardResponse (Maybe Text)
updateDashboardResponse_creationStatus :: Lens' UpdateDashboardResponse (Maybe ResourceStatus)
updateDashboardResponse_dashboardId :: Lens' UpdateDashboardResponse (Maybe Text)
updateDashboardResponse_requestId :: Lens' UpdateDashboardResponse (Maybe Text)
updateDashboardResponse_status :: Lens' UpdateDashboardResponse (Maybe Int)
updateDashboardResponse_versionArn :: Lens' UpdateDashboardResponse (Maybe Text)
updateDashboardResponse_httpStatus :: Lens' UpdateDashboardResponse Int

Creating a Request

data UpdateDashboard Source #

See: newUpdateDashboard smart constructor.

Constructors

UpdateDashboard'

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
A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
sourceEntity :: Maybe DashboardSourceEntity
The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update 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 SourceTemplate ARN 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.
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 was originally associated with the 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 that contains the dashboard that you're updating.
dashboardId :: Text
The ID for the dashboard.
name :: Text
The display name of the dashboard.

Instances

Instances details

ToJSON UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods toJSON :: UpdateDashboard -> Value # toEncoding :: UpdateDashboard -> Encoding # toJSONList :: [UpdateDashboard] -> Value # toEncodingList :: [UpdateDashboard] -> Encoding #
ToHeaders UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods toHeaders :: UpdateDashboard -> [Header] #
ToPath UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods toPath :: UpdateDashboard -> ByteString #
ToQuery UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods toQuery :: UpdateDashboard -> QueryString #
AWSRequest UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Associated Types type AWSResponse UpdateDashboard # Methods request :: (Service -> Service) -> UpdateDashboard -> Request UpdateDashboard # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDashboard -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDashboard))) #
Generic UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Associated Types type Rep UpdateDashboard :: Type -> Type # Methods from :: UpdateDashboard -> Rep UpdateDashboard x # to :: Rep UpdateDashboard x -> UpdateDashboard #
Show UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods showsPrec :: Int -> UpdateDashboard -> ShowS # show :: UpdateDashboard -> String # showList :: [UpdateDashboard] -> ShowS #
NFData UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods rnf :: UpdateDashboard -> () #
Eq UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods (==) :: UpdateDashboard -> UpdateDashboard -> Bool # (/=) :: UpdateDashboard -> UpdateDashboard -> Bool #
Hashable UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods hashWithSalt :: Int -> UpdateDashboard -> Int # hash :: UpdateDashboard -> Int #
type AWSResponse UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard type AWSResponse UpdateDashboard = UpdateDashboardResponse
type Rep UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard type Rep UpdateDashboard = D1 ('MetaData "UpdateDashboard" "Amazonka.QuickSight.UpdateDashboard" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateDashboard'" '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 "sourceEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DashboardSourceEntity)))) :: ((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))))))

newUpdateDashboard Source #

Arguments

:: Text	`UpdateDashboard`
-> Text	`UpdateDashboard`
-> Text	`UpdateDashboard`
-> UpdateDashboard

Create a value of UpdateDashboard 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:UpdateDashboard', updateDashboard_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:UpdateDashboard', updateDashboard_definition - The definition of a dashboard.

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

$sel:parameters:UpdateDashboard', updateDashboard_parameters - A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

$sel:sourceEntity:UpdateDashboard', updateDashboard_sourceEntity - The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update 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 SourceTemplate ARN 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.

UpdateDashboard, updateDashboard_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 was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

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

UpdateDashboard, updateDashboard_awsAccountId - The ID of the Amazon Web Services account that contains the dashboard that you're updating.

UpdateDashboard, updateDashboard_dashboardId - The ID for the dashboard.

UpdateDashboard, updateDashboard_name - The display name of the dashboard.

Request Lenses

updateDashboard_dashboardPublishOptions :: Lens' UpdateDashboard (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.

updateDashboard_definition :: Lens' UpdateDashboard (Maybe DashboardVersionDefinition) Source #

The definition of a dashboard.

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

updateDashboard_parameters :: Lens' UpdateDashboard (Maybe Parameters) Source #

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

updateDashboard_sourceEntity :: Lens' UpdateDashboard (Maybe DashboardSourceEntity) Source #

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update 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 SourceTemplate ARN 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.

updateDashboard_themeArn :: Lens' UpdateDashboard (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 was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

updateDashboard_versionDescription :: Lens' UpdateDashboard (Maybe Text) Source #

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

updateDashboard_awsAccountId :: Lens' UpdateDashboard Text Source #

The ID of the Amazon Web Services account that contains the dashboard that you're updating.

updateDashboard_dashboardId :: Lens' UpdateDashboard Text Source #

The ID for the dashboard.

updateDashboard_name :: Lens' UpdateDashboard Text Source #

The display name of the dashboard.

Destructuring the Response

data UpdateDashboardResponse Source #

See: newUpdateDashboardResponse smart constructor.

Constructors

UpdateDashboardResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the resource.
creationStatus :: Maybe ResourceStatus
The creation status of the request.
dashboardId :: Maybe Text
The ID for the dashboard.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
status :: Maybe Int
The HTTP status of the request.
versionArn :: Maybe Text
The ARN of the dashboard, including the version number.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newUpdateDashboardResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateDashboardResponse'`
-> UpdateDashboardResponse

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

UpdateDashboardResponse, updateDashboardResponse_arn - The Amazon Resource Name (ARN) of the resource.

UpdateDashboardResponse, updateDashboardResponse_creationStatus - The creation status of the request.

UpdateDashboard, updateDashboardResponse_dashboardId - The ID for the dashboard.

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

UpdateDashboardResponse, updateDashboardResponse_status - The HTTP status of the request.

$sel:versionArn:UpdateDashboardResponse', updateDashboardResponse_versionArn - The ARN of the dashboard, including the version number.

$sel:httpStatus:UpdateDashboardResponse', updateDashboardResponse_httpStatus - The response's http status code.

Response Lenses

updateDashboardResponse_arn :: Lens' UpdateDashboardResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

updateDashboardResponse_creationStatus :: Lens' UpdateDashboardResponse (Maybe ResourceStatus) Source #

The creation status of the request.

updateDashboardResponse_dashboardId :: Lens' UpdateDashboardResponse (Maybe Text) Source #

The ID for the dashboard.

updateDashboardResponse_requestId :: Lens' UpdateDashboardResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDashboardResponse_status :: Lens' UpdateDashboardResponse (Maybe Int) Source #

The HTTP status of the request.

updateDashboardResponse_versionArn :: Lens' UpdateDashboardResponse (Maybe Text) Source #

The ARN of the dashboard, including the version number.

updateDashboardResponse_httpStatus :: Lens' UpdateDashboardResponse Int Source #

The response's http status code.