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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an IoT SiteWise Monitor dashboard.

Creating a Request

data UpdateDashboard Source #

See: newUpdateDashboard smart constructor.

Constructors

UpdateDashboard'

Fields

clientToken :: Maybe Text
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
dashboardDescription :: Maybe Text
A new description for the dashboard.
dashboardId :: Text
The ID of the dashboard to update.
dashboardName :: Text
A new friendly name for the dashboard.
dashboardDefinition :: Text
The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

Instances

Instances details

ToJSON UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods toJSON :: UpdateDashboard -> Value # toEncoding :: UpdateDashboard -> Encoding # toJSONList :: [UpdateDashboard] -> Value # toEncodingList :: [UpdateDashboard] -> Encoding #
ToHeaders UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods toHeaders :: UpdateDashboard -> [Header] #
ToPath UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods toPath :: UpdateDashboard -> ByteString #
ToQuery UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods toQuery :: UpdateDashboard -> QueryString #
AWSRequest UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.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.IoTSiteWise.UpdateDashboard Associated Types type Rep UpdateDashboard :: Type -> Type # Methods from :: UpdateDashboard -> Rep UpdateDashboard x # to :: Rep UpdateDashboard x -> UpdateDashboard #
Read UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods readsPrec :: Int -> ReadS UpdateDashboard # readList :: ReadS [UpdateDashboard] # readPrec :: ReadPrec UpdateDashboard # readListPrec :: ReadPrec [UpdateDashboard] #
Show UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods showsPrec :: Int -> UpdateDashboard -> ShowS # show :: UpdateDashboard -> String # showList :: [UpdateDashboard] -> ShowS #
NFData UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods rnf :: UpdateDashboard -> () #
Eq UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods (==) :: UpdateDashboard -> UpdateDashboard -> Bool # (/=) :: UpdateDashboard -> UpdateDashboard -> Bool #
Hashable UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods hashWithSalt :: Int -> UpdateDashboard -> Int # hash :: UpdateDashboard -> Int #
type AWSResponse UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard type AWSResponse UpdateDashboard = UpdateDashboardResponse
type Rep UpdateDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard type Rep UpdateDashboard = D1 ('MetaData "UpdateDashboard" "Amazonka.IoTSiteWise.UpdateDashboard" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "UpdateDashboard'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dashboardDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dashboardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "dashboardName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "dashboardDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateDashboard Source #

Arguments

:: Text	`$sel:dashboardId:UpdateDashboard'`
-> Text	`$sel:dashboardName:UpdateDashboard'`
-> Text	`$sel:dashboardDefinition: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:clientToken:UpdateDashboard', updateDashboard_clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

$sel:dashboardDescription:UpdateDashboard', updateDashboard_dashboardDescription - A new description for the dashboard.

$sel:dashboardId:UpdateDashboard', updateDashboard_dashboardId - The ID of the dashboard to update.

$sel:dashboardName:UpdateDashboard', updateDashboard_dashboardName - A new friendly name for the dashboard.

$sel:dashboardDefinition:UpdateDashboard', updateDashboard_dashboardDefinition - The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

Request Lenses

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

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

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

A new description for the dashboard.

updateDashboard_dashboardId :: Lens' UpdateDashboard Text Source #

The ID of the dashboard to update.

updateDashboard_dashboardName :: Lens' UpdateDashboard Text Source #

A new friendly name for the dashboard.

updateDashboard_dashboardDefinition :: Lens' UpdateDashboard Text Source #

The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

Destructuring the Response

data UpdateDashboardResponse Source #

See: newUpdateDashboardResponse smart constructor.

Constructors

UpdateDashboardResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.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.IoTSiteWise.UpdateDashboard Methods readsPrec :: Int -> ReadS UpdateDashboardResponse # readList :: ReadS [UpdateDashboardResponse] # readPrec :: ReadPrec UpdateDashboardResponse # readListPrec :: ReadPrec [UpdateDashboardResponse] #
Show UpdateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods showsPrec :: Int -> UpdateDashboardResponse -> ShowS # show :: UpdateDashboardResponse -> String # showList :: [UpdateDashboardResponse] -> ShowS #
NFData UpdateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods rnf :: UpdateDashboardResponse -> () #
Eq UpdateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard Methods (==) :: UpdateDashboardResponse -> UpdateDashboardResponse -> Bool # (/=) :: UpdateDashboardResponse -> UpdateDashboardResponse -> Bool #
type Rep UpdateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateDashboard type Rep UpdateDashboardResponse = D1 ('MetaData "UpdateDashboardResponse" "Amazonka.IoTSiteWise.UpdateDashboard" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "UpdateDashboardResponse'" 'PrefixI 'True) (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:httpStatus:UpdateDashboardResponse', updateDashboardResponse_httpStatus - The response's http status code.

Response Lenses

updateDashboardResponse_httpStatus :: Lens' UpdateDashboardResponse Int Source #

The response's http status code.