Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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

Creating a Request

data UpdateDashboard Source #

See: newUpdateDashboard smart constructor.

Constructors

UpdateDashboard'

Fields

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.
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.
versionDescription :: Maybe Text
A description for the first version of the dashboard being created.
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.
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.
sourceEntity :: 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.

Instances

Instances details

Eq UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods (==) :: UpdateDashboard -> UpdateDashboard -> Bool # (/=) :: UpdateDashboard -> UpdateDashboard -> Bool #
Read UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods readsPrec :: Int -> ReadS UpdateDashboard # readList :: ReadS [UpdateDashboard] # readPrec :: ReadPrec UpdateDashboard # readListPrec :: ReadPrec [UpdateDashboard] #
Show UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods showsPrec :: Int -> UpdateDashboard -> ShowS # show :: UpdateDashboard -> String # showList :: [UpdateDashboard] -> ShowS #
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 #
NFData UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods rnf :: UpdateDashboard -> () #
Hashable UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods hashWithSalt :: Int -> UpdateDashboard -> Int # hash :: UpdateDashboard -> Int #
ToJSON UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods toJSON :: UpdateDashboard -> Value # toEncoding :: UpdateDashboard -> Encoding # toJSONList :: [UpdateDashboard] -> Value # toEncodingList :: [UpdateDashboard] -> Encoding #
AWSRequest UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Associated Types type AWSResponse UpdateDashboard # Methods request :: UpdateDashboard -> Request UpdateDashboard # response :: MonadResource m => Logger -> Service -> Proxy UpdateDashboard -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDashboard))) #
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 #
type Rep UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard type Rep UpdateDashboard = D1 ('MetaData "UpdateDashboard" "Amazonka.QuickSight.UpdateDashboard" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "UpdateDashboard'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "themeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dashboardPublishOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DashboardPublishOptions))) :: (S1 ('MetaSel ('Just "versionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Parameters)))) :: ((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) :*: S1 ('MetaSel ('Just "sourceEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DashboardSourceEntity)))))
type AWSResponse UpdateDashboard Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard type AWSResponse UpdateDashboard = UpdateDashboardResponse

newUpdateDashboard Source #

Arguments

:: Text	`$sel:awsAccountId:UpdateDashboard'`
-> Text	`$sel:dashboardId:UpdateDashboard'`
-> Text	`$sel:name:UpdateDashboard'`
-> DashboardSourceEntity	`$sel:sourceEntity: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:themeArn: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: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:versionDescription:UpdateDashboard', updateDashboard_versionDescription - A description for the first version of the dashboard being created.

$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:awsAccountId:UpdateDashboard', updateDashboard_awsAccountId - The ID of the Amazon Web Services account that contains the dashboard that you're updating.

$sel:dashboardId:UpdateDashboard', updateDashboard_dashboardId - The ID for the dashboard.

$sel:name:UpdateDashboard', updateDashboard_name - The display name of the dashboard.

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

Request Lenses

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_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_versionDescription :: Lens' UpdateDashboard (Maybe Text) Source #

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

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

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

Destructuring the Response

data UpdateDashboardResponse Source #

See: newUpdateDashboardResponse smart constructor.

Constructors

UpdateDashboardResponse'

Fields

requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
status :: Maybe Int
The HTTP status of the request.
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.
versionArn :: Maybe Text
The ARN of the dashboard, including the version number.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq UpdateDashboardResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods (==) :: UpdateDashboardResponse -> UpdateDashboardResponse -> Bool # (/=) :: UpdateDashboardResponse -> UpdateDashboardResponse -> Bool #
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 #
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 #
NFData UpdateDashboardResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard Methods rnf :: UpdateDashboardResponse -> () #
type Rep UpdateDashboardResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateDashboard type Rep UpdateDashboardResponse = D1 ('MetaData "UpdateDashboardResponse" "Amazonka.QuickSight.UpdateDashboard" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "UpdateDashboardResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: 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 "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:

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

$sel:status:UpdateDashboardResponse', updateDashboardResponse_status - The HTTP status of the request.

$sel:arn:UpdateDashboardResponse', updateDashboardResponse_arn - The Amazon Resource Name (ARN) of the resource.

$sel:creationStatus:UpdateDashboardResponse', updateDashboardResponse_creationStatus - The creation status of the request.

$sel:dashboardId:UpdateDashboard', updateDashboardResponse_dashboardId - The ID for the dashboard.

$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_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_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_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.