Amazonka.IoTSiteWise.DescribeDashboard

Retrieves information about a dashboard.

Creating a Request

data DescribeDashboard

See: newDescribeDashboard smart constructor.

Constructors

DescribeDashboard'

Fields

• dashboardId :: Text

  The ID of the dashboard.

Instances

ToHeaders DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

toHeaders :: DescribeDashboard -> [Header]

ToPath DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

toPath :: DescribeDashboard -> ByteString

ToQuery DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

toQuery :: DescribeDashboard -> QueryString

AWSRequest DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Associated Types

type AWSResponse DescribeDashboard

Methods

request :: (Service -> Service) -> DescribeDashboard -> Request DescribeDashboard

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDashboard -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDashboard)))

Generic DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Associated Types

type Rep DescribeDashboard :: Type -> Type

Methods

from :: DescribeDashboard -> Rep DescribeDashboard x

to :: Rep DescribeDashboard x -> DescribeDashboard

Read DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

readsPrec :: Int -> ReadS DescribeDashboard

readList :: ReadS [DescribeDashboard]

readPrec :: ReadPrec DescribeDashboard

readListPrec :: ReadPrec [DescribeDashboard]

Show DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

showsPrec :: Int -> DescribeDashboard -> ShowS

show :: DescribeDashboard -> String

showList :: [DescribeDashboard] -> ShowS

NFData DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

rnf :: DescribeDashboard -> ()

Eq DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

(==) :: DescribeDashboard -> DescribeDashboard -> Bool

(/=) :: DescribeDashboard -> DescribeDashboard -> Bool

Hashable DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

hashWithSalt :: Int -> DescribeDashboard -> Int

hash :: DescribeDashboard -> Int

type AWSResponse DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

type AWSResponse DescribeDashboard = DescribeDashboardResponse

type Rep DescribeDashboard

Defined in Amazonka.IoTSiteWise.DescribeDashboard

type Rep DescribeDashboard = D1 ('MetaData "DescribeDashboard" "Amazonka.IoTSiteWise.DescribeDashboard" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeDashboard'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dashboardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDashboard

Arguments

:: Text

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:

DescribeDashboard, describeDashboard_dashboardId - The ID of the dashboard.

Request Lenses

describeDashboard_dashboardId :: Lens' DescribeDashboard Text

The ID of the dashboard.

Destructuring the Response

data DescribeDashboardResponse

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

Generic DescribeDashboardResponse

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Associated Types

type Rep DescribeDashboardResponse :: Type -> Type

Methods

from :: DescribeDashboardResponse -> Rep DescribeDashboardResponse x

to :: Rep DescribeDashboardResponse x -> DescribeDashboardResponse

Read DescribeDashboardResponse

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

readsPrec :: Int -> ReadS DescribeDashboardResponse

readList :: ReadS [DescribeDashboardResponse]

readPrec :: ReadPrec DescribeDashboardResponse

readListPrec :: ReadPrec [DescribeDashboardResponse]

Show DescribeDashboardResponse

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

showsPrec :: Int -> DescribeDashboardResponse -> ShowS

show :: DescribeDashboardResponse -> String

showList :: [DescribeDashboardResponse] -> ShowS

NFData DescribeDashboardResponse

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

rnf :: DescribeDashboardResponse -> ()

Eq DescribeDashboardResponse

Defined in Amazonka.IoTSiteWise.DescribeDashboard

Methods

(==) :: DescribeDashboardResponse -> DescribeDashboardResponse -> Bool

(/=) :: DescribeDashboardResponse -> DescribeDashboardResponse -> Bool

type Rep DescribeDashboardResponse

Defined in Amazonka.IoTSiteWise.DescribeDashboard

type Rep DescribeDashboardResponse = D1 ('MetaData "DescribeDashboardResponse" "Amazonka.IoTSiteWise.DescribeDashboard" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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

Arguments

:: Int

$sel:httpStatus:DescribeDashboardResponse'

-> Text

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.

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)

The dashboard's description.

describeDashboardResponse_httpStatus :: Lens' DescribeDashboardResponse Int

The response's http status code.

describeDashboardResponse_dashboardId :: Lens' DescribeDashboardResponse Text

The ID of the dashboard.

describeDashboardResponse_dashboardArn :: Lens' DescribeDashboardResponse Text

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

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

describeDashboardResponse_dashboardName :: Lens' DescribeDashboardResponse Text

The name of the dashboard.

describeDashboardResponse_projectId :: Lens' DescribeDashboardResponse Text

The ID of the project that the dashboard is in.

describeDashboardResponse_dashboardDefinition :: Lens' DescribeDashboardResponse Text

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

describeDashboardResponse_dashboardCreationDate :: Lens' DescribeDashboardResponse UTCTime

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

describeDashboardResponse_dashboardLastUpdateDate :: Lens' DescribeDashboardResponse UTCTime

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