Amazonka.IoTSiteWise.CreateDashboard

Creates a dashboard in an IoT SiteWise Monitor project.

Creating a Request

data CreateDashboard

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

ToJSON CreateDashboard

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

toJSON :: CreateDashboard -> Value

toEncoding :: CreateDashboard -> Encoding

toJSONList :: [CreateDashboard] -> Value

toEncodingList :: [CreateDashboard] -> Encoding

ToHeaders CreateDashboard

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

toHeaders :: CreateDashboard -> [Header]

ToPath CreateDashboard

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

toPath :: CreateDashboard -> ByteString

ToQuery CreateDashboard

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

toQuery :: CreateDashboard -> QueryString

AWSRequest CreateDashboard

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

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

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

readsPrec :: Int -> ReadS CreateDashboard

readList :: ReadS [CreateDashboard]

readPrec :: ReadPrec CreateDashboard

readListPrec :: ReadPrec [CreateDashboard]

Show CreateDashboard

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

showsPrec :: Int -> CreateDashboard -> ShowS

show :: CreateDashboard -> String

showList :: [CreateDashboard] -> ShowS

NFData CreateDashboard

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

rnf :: CreateDashboard -> ()

Eq CreateDashboard

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

(==) :: CreateDashboard -> CreateDashboard -> Bool

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

Hashable CreateDashboard

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

hashWithSalt :: Int -> CreateDashboard -> Int

hash :: CreateDashboard -> Int

type AWSResponse CreateDashboard

Defined in Amazonka.IoTSiteWise.CreateDashboard

type AWSResponse CreateDashboard = CreateDashboardResponse

type Rep CreateDashboard

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

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)

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)

A description for the dashboard.

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

createDashboard_projectId :: Lens' CreateDashboard Text

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

createDashboard_dashboardName :: Lens' CreateDashboard Text

A friendly name for the dashboard.

createDashboard_dashboardDefinition :: Lens' CreateDashboard Text

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

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

Generic CreateDashboardResponse

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

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

readsPrec :: Int -> ReadS CreateDashboardResponse

readList :: ReadS [CreateDashboardResponse]

readPrec :: ReadPrec CreateDashboardResponse

readListPrec :: ReadPrec [CreateDashboardResponse]

Show CreateDashboardResponse

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

showsPrec :: Int -> CreateDashboardResponse -> ShowS

show :: CreateDashboardResponse -> String

showList :: [CreateDashboardResponse] -> ShowS

NFData CreateDashboardResponse

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

rnf :: CreateDashboardResponse -> ()

Eq CreateDashboardResponse

Defined in Amazonka.IoTSiteWise.CreateDashboard

Methods

(==) :: CreateDashboardResponse -> CreateDashboardResponse -> Bool

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

type Rep CreateDashboardResponse

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

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

The response's http status code.

createDashboardResponse_dashboardId :: Lens' CreateDashboardResponse Text

The ID of the dashboard.

createDashboardResponse_dashboardArn :: Lens' CreateDashboardResponse Text

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

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