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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a dashboard in an IoT SiteWise Monitor project.

Synopsis

data CreateDashboard = CreateDashboard' {
- clientToken :: Maybe Text
- dashboardDescription :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- projectId :: Text
- dashboardName :: Text
- dashboardDefinition :: Text
}
newCreateDashboard :: Text -> Text -> Text -> CreateDashboard
createDashboard_clientToken :: Lens' CreateDashboard (Maybe Text)
createDashboard_dashboardDescription :: Lens' CreateDashboard (Maybe Text)
createDashboard_tags :: Lens' CreateDashboard (Maybe (HashMap Text Text))
createDashboard_projectId :: Lens' CreateDashboard Text
createDashboard_dashboardName :: Lens' CreateDashboard Text
createDashboard_dashboardDefinition :: Lens' CreateDashboard Text
data CreateDashboardResponse = CreateDashboardResponse' {
- httpStatus :: Int
- dashboardId :: Text
- dashboardArn :: Text
}
newCreateDashboardResponse :: Int -> Text -> Text -> CreateDashboardResponse
createDashboardResponse_httpStatus :: Lens' CreateDashboardResponse Int
createDashboardResponse_dashboardId :: Lens' CreateDashboardResponse Text
createDashboardResponse_dashboardArn :: Lens' CreateDashboardResponse Text

Creating a Request

data CreateDashboard Source #

See: newCreateDashboard smart constructor.

Constructors

CreateDashboard'

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 description for the dashboard.
tags :: Maybe (HashMap Text Text)
A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
projectId :: Text
The ID of the project in which to create the dashboard.
dashboardName :: Text
A friendly name for the dashboard.
dashboardDefinition :: Text
The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

Instances

Instances details

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

newCreateDashboard Source #

Arguments

:: Text	`$sel:projectId:CreateDashboard'`
-> Text	`$sel:dashboardName:CreateDashboard'`
-> Text	`$sel:dashboardDefinition: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:clientToken:CreateDashboard', createDashboard_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:CreateDashboard', createDashboard_dashboardDescription - A description for the dashboard.

$sel:tags:CreateDashboard', createDashboard_tags - A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

$sel:projectId:CreateDashboard', createDashboard_projectId - The ID of the project in which to create the dashboard.

$sel:dashboardName:CreateDashboard', createDashboard_dashboardName - A friendly name for the dashboard.

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

Request Lenses

createDashboard_clientToken :: Lens' CreateDashboard (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.

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

A description for the dashboard.

createDashboard_tags :: Lens' CreateDashboard (Maybe (HashMap Text Text)) Source #

A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

createDashboard_projectId :: Lens' CreateDashboard Text Source #

The ID of the project in which to create the dashboard.

createDashboard_dashboardName :: Lens' CreateDashboard Text Source #

A friendly name for the dashboard.

createDashboard_dashboardDefinition :: Lens' CreateDashboard Text Source #

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

Destructuring the Response

data CreateDashboardResponse Source #

See: newCreateDashboardResponse smart constructor.

Constructors

CreateDashboardResponse'
Fields httpStatus :: Int The response's http status code. dashboardId :: Text The ID of the dashboard. dashboardArn :: Text The ARN of the dashboard, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

Instances

Instances details

Generic CreateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.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.IoTSiteWise.CreateDashboard Methods readsPrec :: Int -> ReadS CreateDashboardResponse # readList :: ReadS [CreateDashboardResponse] # readPrec :: ReadPrec CreateDashboardResponse # readListPrec :: ReadPrec [CreateDashboardResponse] #
Show CreateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateDashboard Methods showsPrec :: Int -> CreateDashboardResponse -> ShowS # show :: CreateDashboardResponse -> String # showList :: [CreateDashboardResponse] -> ShowS #
NFData CreateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateDashboard Methods rnf :: CreateDashboardResponse -> () #
Eq CreateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateDashboard Methods (==) :: CreateDashboardResponse -> CreateDashboardResponse -> Bool # (/=) :: CreateDashboardResponse -> CreateDashboardResponse -> Bool #
type Rep CreateDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateDashboard type Rep CreateDashboardResponse = D1 ('MetaData "CreateDashboardResponse" "Amazonka.IoTSiteWise.CreateDashboard" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "CreateDashboardResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "dashboardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "dashboardArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDashboardResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDashboardResponse'`
-> Text	`$sel:dashboardId:CreateDashboardResponse'`
-> Text	`$sel:dashboardArn: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:

$sel:httpStatus:CreateDashboardResponse', createDashboardResponse_httpStatus - The response's http status code.

$sel:dashboardId:CreateDashboardResponse', createDashboardResponse_dashboardId - The ID of the dashboard.

$sel:dashboardArn:CreateDashboardResponse', createDashboardResponse_dashboardArn - The ARN of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

Response Lenses

createDashboardResponse_httpStatus :: Lens' CreateDashboardResponse Int Source #

The response's http status code.

createDashboardResponse_dashboardId :: Lens' CreateDashboardResponse Text Source #

The ID of the dashboard.

createDashboardResponse_dashboardArn :: Lens' CreateDashboardResponse Text Source #

The ARN of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}