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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a dashboard.

Synopsis

data DescribeDashboard = DescribeDashboard' {
- dashboardId :: Text
}
newDescribeDashboard :: Text -> DescribeDashboard
describeDashboard_dashboardId :: Lens' DescribeDashboard Text
data DescribeDashboardResponse = DescribeDashboardResponse' {
- dashboardDescription :: Maybe Text
- httpStatus :: Int
- dashboardId :: Text
- dashboardArn :: Text
- dashboardName :: Text
- projectId :: Text
- dashboardDefinition :: Text
- dashboardCreationDate :: POSIX
- dashboardLastUpdateDate :: POSIX
}
newDescribeDashboardResponse :: Int -> Text -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> DescribeDashboardResponse
describeDashboardResponse_dashboardDescription :: Lens' DescribeDashboardResponse (Maybe Text)
describeDashboardResponse_httpStatus :: Lens' DescribeDashboardResponse Int
describeDashboardResponse_dashboardId :: Lens' DescribeDashboardResponse Text
describeDashboardResponse_dashboardArn :: Lens' DescribeDashboardResponse Text
describeDashboardResponse_dashboardName :: Lens' DescribeDashboardResponse Text
describeDashboardResponse_projectId :: Lens' DescribeDashboardResponse Text
describeDashboardResponse_dashboardDefinition :: Lens' DescribeDashboardResponse Text
describeDashboardResponse_dashboardCreationDate :: Lens' DescribeDashboardResponse UTCTime
describeDashboardResponse_dashboardLastUpdateDate :: Lens' DescribeDashboardResponse UTCTime

Creating a Request

data DescribeDashboard Source #

See: newDescribeDashboard smart constructor.

Constructors

DescribeDashboard'
Fields dashboardId :: Text The ID of the dashboard.

Instances

Instances details

Eq DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods (==) :: DescribeDashboard -> DescribeDashboard -> Bool # (/=) :: DescribeDashboard -> DescribeDashboard -> Bool #
Read DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods readsPrec :: Int -> ReadS DescribeDashboard # readList :: ReadS [DescribeDashboard] # readPrec :: ReadPrec DescribeDashboard # readListPrec :: ReadPrec [DescribeDashboard] #
Show DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods showsPrec :: Int -> DescribeDashboard -> ShowS # show :: DescribeDashboard -> String # showList :: [DescribeDashboard] -> ShowS #
Generic DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Associated Types type Rep DescribeDashboard :: Type -> Type # Methods from :: DescribeDashboard -> Rep DescribeDashboard x # to :: Rep DescribeDashboard x -> DescribeDashboard #
NFData DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods rnf :: DescribeDashboard -> () #
Hashable DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods hashWithSalt :: Int -> DescribeDashboard -> Int # hash :: DescribeDashboard -> Int #
AWSRequest DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Associated Types type AWSResponse DescribeDashboard # Methods request :: DescribeDashboard -> Request DescribeDashboard # response :: MonadResource m => Logger -> Service -> Proxy DescribeDashboard -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDashboard))) #
ToHeaders DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods toHeaders :: DescribeDashboard -> [Header] #
ToPath DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods toPath :: DescribeDashboard -> ByteString #
ToQuery DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods toQuery :: DescribeDashboard -> QueryString #
type Rep DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard type Rep DescribeDashboard = D1 ('MetaData "DescribeDashboard" "Amazonka.IoTSiteWise.DescribeDashboard" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribeDashboard'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dashboardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDashboard Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard type AWSResponse DescribeDashboard = DescribeDashboardResponse

newDescribeDashboard Source #

Arguments

:: Text	`$sel:dashboardId:DescribeDashboard'`
-> DescribeDashboard

Create a value of DescribeDashboard 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:dashboardId:DescribeDashboard', describeDashboard_dashboardId - The ID of the dashboard.

Request Lenses

describeDashboard_dashboardId :: Lens' DescribeDashboard Text Source #

The ID of the dashboard.

Destructuring the Response

data DescribeDashboardResponse Source #

See: newDescribeDashboardResponse smart constructor.

Constructors

DescribeDashboardResponse'

Fields

dashboardDescription :: Maybe Text
The dashboard's description.
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}

dashboardName :: Text
The name of the dashboard.
projectId :: Text
The ID of the project that the dashboard is in.
dashboardDefinition :: Text
The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
dashboardCreationDate :: POSIX
The date the dashboard was created, in Unix epoch time.
dashboardLastUpdateDate :: POSIX
The date the dashboard was last updated, in Unix epoch time.

Instances

Instances details

Eq DescribeDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods (==) :: DescribeDashboardResponse -> DescribeDashboardResponse -> Bool # (/=) :: DescribeDashboardResponse -> DescribeDashboardResponse -> Bool #
Read DescribeDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods readsPrec :: Int -> ReadS DescribeDashboardResponse # readList :: ReadS [DescribeDashboardResponse] # readPrec :: ReadPrec DescribeDashboardResponse # readListPrec :: ReadPrec [DescribeDashboardResponse] #
Show DescribeDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods showsPrec :: Int -> DescribeDashboardResponse -> ShowS # show :: DescribeDashboardResponse -> String # showList :: [DescribeDashboardResponse] -> ShowS #
Generic DescribeDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Associated Types type Rep DescribeDashboardResponse :: Type -> Type # Methods from :: DescribeDashboardResponse -> Rep DescribeDashboardResponse x # to :: Rep DescribeDashboardResponse x -> DescribeDashboardResponse #
NFData DescribeDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard Methods rnf :: DescribeDashboardResponse -> () #
type Rep DescribeDashboardResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeDashboard type Rep DescribeDashboardResponse = D1 ('MetaData "DescribeDashboardResponse" "Amazonka.IoTSiteWise.DescribeDashboard" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribeDashboardResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dashboardDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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))) :: ((S1 ('MetaSel ('Just "dashboardName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "dashboardDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "dashboardCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "dashboardLastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDescribeDashboardResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDashboardResponse'`
-> Text	`$sel:dashboardId:DescribeDashboard'`
-> Text	`$sel:dashboardArn:DescribeDashboardResponse'`
-> Text	`$sel:dashboardName:DescribeDashboardResponse'`
-> Text	`$sel:projectId:DescribeDashboardResponse'`
-> Text	`$sel:dashboardDefinition:DescribeDashboardResponse'`
-> UTCTime	`$sel:dashboardCreationDate:DescribeDashboardResponse'`
-> UTCTime	`$sel:dashboardLastUpdateDate:DescribeDashboardResponse'`
-> DescribeDashboardResponse

Create a value of DescribeDashboardResponse 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:dashboardDescription:DescribeDashboardResponse', describeDashboardResponse_dashboardDescription - The dashboard's description.

$sel:httpStatus:DescribeDashboardResponse', describeDashboardResponse_httpStatus - The response's http status code.

$sel:dashboardId:DescribeDashboard', describeDashboardResponse_dashboardId - The ID of the dashboard.

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

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

$sel:dashboardName:DescribeDashboardResponse', describeDashboardResponse_dashboardName - The name of the dashboard.

$sel:projectId:DescribeDashboardResponse', describeDashboardResponse_projectId - The ID of the project that the dashboard is in.

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

$sel:dashboardCreationDate:DescribeDashboardResponse', describeDashboardResponse_dashboardCreationDate - The date the dashboard was created, in Unix epoch time.

$sel:dashboardLastUpdateDate:DescribeDashboardResponse', describeDashboardResponse_dashboardLastUpdateDate - The date the dashboard was last updated, in Unix epoch time.

Response Lenses

describeDashboardResponse_dashboardDescription :: Lens' DescribeDashboardResponse (Maybe Text) Source #

The dashboard's description.

describeDashboardResponse_httpStatus :: Lens' DescribeDashboardResponse Int Source #

The response's http status code.

describeDashboardResponse_dashboardId :: Lens' DescribeDashboardResponse Text Source #

The ID of the dashboard.

describeDashboardResponse_dashboardArn :: Lens' DescribeDashboardResponse Text Source #

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

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

describeDashboardResponse_dashboardName :: Lens' DescribeDashboardResponse Text Source #

The name of the dashboard.

describeDashboardResponse_projectId :: Lens' DescribeDashboardResponse Text Source #

The ID of the project that the dashboard is in.

describeDashboardResponse_dashboardDefinition :: Lens' DescribeDashboardResponse Text Source #

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

describeDashboardResponse_dashboardCreationDate :: Lens' DescribeDashboardResponse UTCTime Source #

The date the dashboard was created, in Unix epoch time.

describeDashboardResponse_dashboardLastUpdateDate :: Lens' DescribeDashboardResponse UTCTime Source #

The date the dashboard was last updated, in Unix epoch time.