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.CloudWatch.GetDashboard

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

Creating a Request

data GetDashboard Source #

See: newGetDashboard smart constructor.

Constructors

GetDashboard'
Fields dashboardName :: Text The name of the dashboard to be described.

Instances

Instances details

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

newGetDashboard Source #

Arguments

:: Text	`GetDashboard`
-> GetDashboard

Create a value of GetDashboard 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:

GetDashboard, getDashboard_dashboardName - The name of the dashboard to be described.

Request Lenses

getDashboard_dashboardName :: Lens' GetDashboard Text Source #

The name of the dashboard to be described.

Destructuring the Response

data GetDashboardResponse Source #

See: newGetDashboardResponse smart constructor.

Constructors

GetDashboardResponse'

Fields

dashboardArn :: Maybe Text
The Amazon Resource Name (ARN) of the dashboard.
dashboardBody :: Maybe Text
The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see Dashboard Body Structure and Syntax.
dashboardName :: Maybe Text
The name of the dashboard.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetDashboardResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetDashboard Associated Types type Rep GetDashboardResponse :: Type -> Type # Methods from :: GetDashboardResponse -> Rep GetDashboardResponse x # to :: Rep GetDashboardResponse x -> GetDashboardResponse #
Read GetDashboardResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetDashboard Methods readsPrec :: Int -> ReadS GetDashboardResponse # readList :: ReadS [GetDashboardResponse] # readPrec :: ReadPrec GetDashboardResponse # readListPrec :: ReadPrec [GetDashboardResponse] #
Show GetDashboardResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetDashboard Methods showsPrec :: Int -> GetDashboardResponse -> ShowS # show :: GetDashboardResponse -> String # showList :: [GetDashboardResponse] -> ShowS #
NFData GetDashboardResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetDashboard Methods rnf :: GetDashboardResponse -> () #
Eq GetDashboardResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetDashboard Methods (==) :: GetDashboardResponse -> GetDashboardResponse -> Bool # (/=) :: GetDashboardResponse -> GetDashboardResponse -> Bool #
type Rep GetDashboardResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetDashboard type Rep GetDashboardResponse = D1 ('MetaData "GetDashboardResponse" "Amazonka.CloudWatch.GetDashboard" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "GetDashboardResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dashboardArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dashboardBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dashboardName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDashboardResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDashboardResponse'`
-> GetDashboardResponse

Create a value of GetDashboardResponse 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:

GetDashboardResponse, getDashboardResponse_dashboardArn - The Amazon Resource Name (ARN) of the dashboard.

$sel:dashboardBody:GetDashboardResponse', getDashboardResponse_dashboardBody - The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see Dashboard Body Structure and Syntax.

GetDashboard, getDashboardResponse_dashboardName - The name of the dashboard.

$sel:httpStatus:GetDashboardResponse', getDashboardResponse_httpStatus - The response's http status code.

Response Lenses

getDashboardResponse_dashboardArn :: Lens' GetDashboardResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dashboard.

getDashboardResponse_dashboardBody :: Lens' GetDashboardResponse (Maybe Text) Source #

The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see Dashboard Body Structure and Syntax.

getDashboardResponse_dashboardName :: Lens' GetDashboardResponse (Maybe Text) Source #

The name of the dashboard.

getDashboardResponse_httpStatus :: Lens' GetDashboardResponse Int Source #

The response's http status code.