Network.AWS.CloudWatch.PutDashboard

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

You can have up to 500 dashboards per account. All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard , and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard .

When you create a dashboard with PutDashboard , a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

Creating a Request

putDashboard

Arguments

:: Text

pdDashboardName

-> Text

pdDashboardBody

-> PutDashboard

Creates a value of PutDashboard with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pdDashboardName - The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required.
• pdDashboardBody - The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required. For more information about the syntax, see 'CloudWatch-Dashboard-Body-Structure' .

data PutDashboard

See: putDashboard smart constructor.

Instances

Eq PutDashboard

Methods

(==) :: PutDashboard -> PutDashboard -> Bool

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

Data PutDashboard

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutDashboard -> c PutDashboard

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutDashboard

toConstr :: PutDashboard -> Constr

dataTypeOf :: PutDashboard -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutDashboard)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutDashboard)

gmapT :: (forall b. Data b => b -> b) -> PutDashboard -> PutDashboard

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutDashboard -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutDashboard -> r

gmapQ :: (forall d. Data d => d -> u) -> PutDashboard -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutDashboard -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutDashboard -> m PutDashboard

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutDashboard -> m PutDashboard

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutDashboard -> m PutDashboard

Read PutDashboard

Methods

readsPrec :: Int -> ReadS PutDashboard

readList :: ReadS [PutDashboard]

readPrec :: ReadPrec PutDashboard

readListPrec :: ReadPrec [PutDashboard]

Show PutDashboard

Methods

showsPrec :: Int -> PutDashboard -> ShowS

show :: PutDashboard -> String

showList :: [PutDashboard] -> ShowS

Generic PutDashboard

Associated Types

type Rep PutDashboard :: * -> *

Methods

from :: PutDashboard -> Rep PutDashboard x

to :: Rep PutDashboard x -> PutDashboard

Hashable PutDashboard

Methods

hashWithSalt :: Int -> PutDashboard -> Int

hash :: PutDashboard -> Int

NFData PutDashboard

Methods

rnf :: PutDashboard -> ()

AWSRequest PutDashboard

Associated Types

type Rs PutDashboard :: *

Methods

request :: PutDashboard -> Request PutDashboard

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * PutDashboard -> ClientResponse -> m (Response PutDashboard)

ToHeaders PutDashboard

Methods

toHeaders :: PutDashboard -> [Header]

ToPath PutDashboard

Methods

toPath :: PutDashboard -> ByteString

ToQuery PutDashboard

Methods

toQuery :: PutDashboard -> QueryString

type Rep PutDashboard

type Rep PutDashboard = D1 * (MetaData "PutDashboard" "Network.AWS.CloudWatch.PutDashboard" "amazonka-cloudwatch-1.6.0-9Bblpq0vnZd2Ryjsugueuz" False) (C1 * (MetaCons "PutDashboard'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_pdDashboardName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_pdDashboardBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs PutDashboard

type Rs PutDashboard = PutDashboardResponse

Request Lenses

pdDashboardName :: Lens' PutDashboard Text

The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required.

pdDashboardBody :: Lens' PutDashboard Text

The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required. For more information about the syntax, see 'CloudWatch-Dashboard-Body-Structure' .

Destructuring the Response

putDashboardResponse

Arguments

:: Int

pdrsResponseStatus

-> PutDashboardResponse

Creates a value of PutDashboardResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pdrsDashboardValidationMessages - If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty. If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard may not render. If this result includes error messages, the input was not valid and the operation failed.
• pdrsResponseStatus - -- | The response status code.

data PutDashboardResponse

See: putDashboardResponse smart constructor.

Instances

Eq PutDashboardResponse

Methods

(==) :: PutDashboardResponse -> PutDashboardResponse -> Bool

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

Data PutDashboardResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutDashboardResponse -> c PutDashboardResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutDashboardResponse

toConstr :: PutDashboardResponse -> Constr

dataTypeOf :: PutDashboardResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutDashboardResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutDashboardResponse)

gmapT :: (forall b. Data b => b -> b) -> PutDashboardResponse -> PutDashboardResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutDashboardResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutDashboardResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> PutDashboardResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutDashboardResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutDashboardResponse -> m PutDashboardResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutDashboardResponse -> m PutDashboardResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutDashboardResponse -> m PutDashboardResponse

Read PutDashboardResponse

Methods

readsPrec :: Int -> ReadS PutDashboardResponse

readList :: ReadS [PutDashboardResponse]

readPrec :: ReadPrec PutDashboardResponse

readListPrec :: ReadPrec [PutDashboardResponse]

Show PutDashboardResponse

Methods

showsPrec :: Int -> PutDashboardResponse -> ShowS

show :: PutDashboardResponse -> String

showList :: [PutDashboardResponse] -> ShowS

Generic PutDashboardResponse

Associated Types

type Rep PutDashboardResponse :: * -> *

Methods

from :: PutDashboardResponse -> Rep PutDashboardResponse x

to :: Rep PutDashboardResponse x -> PutDashboardResponse

NFData PutDashboardResponse

Methods

rnf :: PutDashboardResponse -> ()

type Rep PutDashboardResponse

type Rep PutDashboardResponse = D1 * (MetaData "PutDashboardResponse" "Network.AWS.CloudWatch.PutDashboard" "amazonka-cloudwatch-1.6.0-9Bblpq0vnZd2Ryjsugueuz" False) (C1 * (MetaCons "PutDashboardResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_pdrsDashboardValidationMessages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [DashboardValidationMessage]))) (S1 * (MetaSel (Just Symbol "_pdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

pdrsDashboardValidationMessages :: Lens' PutDashboardResponse [DashboardValidationMessage]

If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty. If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard may not render. If this result includes error messages, the input was not valid and the operation failed.

pdrsResponseStatus :: Lens' PutDashboardResponse Int

• - | The response status code.