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.Backup.ListReportPlans

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Creating a Request

data ListReportPlans Source #

See: newListReportPlans smart constructor.

Constructors

ListReportPlans'
Fields maxResults :: Maybe Natural The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data. nextToken :: Maybe Text An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Instances

Instances details

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

newListReportPlans :: ListReportPlans Source #

Create a value of ListReportPlans 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:maxResults:ListReportPlans', listReportPlans_maxResults - The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

ListReportPlans, listReportPlans_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Request Lenses

listReportPlans_maxResults :: Lens' ListReportPlans (Maybe Natural) Source #

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

listReportPlans_nextToken :: Lens' ListReportPlans (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Destructuring the Response

data ListReportPlansResponse Source #

See: newListReportPlansResponse smart constructor.

Constructors

ListReportPlansResponse'

Fields

nextToken :: Maybe Text
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
reportPlans :: Maybe [ReportPlan]
A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListReportPlansResponse Source #
Instance details Defined in Amazonka.Backup.ListReportPlans Associated Types type Rep ListReportPlansResponse :: Type -> Type # Methods from :: ListReportPlansResponse -> Rep ListReportPlansResponse x # to :: Rep ListReportPlansResponse x -> ListReportPlansResponse #
Read ListReportPlansResponse Source #
Instance details Defined in Amazonka.Backup.ListReportPlans Methods readsPrec :: Int -> ReadS ListReportPlansResponse # readList :: ReadS [ListReportPlansResponse] # readPrec :: ReadPrec ListReportPlansResponse # readListPrec :: ReadPrec [ListReportPlansResponse] #
Show ListReportPlansResponse Source #
Instance details Defined in Amazonka.Backup.ListReportPlans Methods showsPrec :: Int -> ListReportPlansResponse -> ShowS # show :: ListReportPlansResponse -> String # showList :: [ListReportPlansResponse] -> ShowS #
NFData ListReportPlansResponse Source #
Instance details Defined in Amazonka.Backup.ListReportPlans Methods rnf :: ListReportPlansResponse -> () #
Eq ListReportPlansResponse Source #
Instance details Defined in Amazonka.Backup.ListReportPlans Methods (==) :: ListReportPlansResponse -> ListReportPlansResponse -> Bool # (/=) :: ListReportPlansResponse -> ListReportPlansResponse -> Bool #
type Rep ListReportPlansResponse Source #
Instance details Defined in Amazonka.Backup.ListReportPlans type Rep ListReportPlansResponse = D1 ('MetaData "ListReportPlansResponse" "Amazonka.Backup.ListReportPlans" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListReportPlansResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "reportPlans") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReportPlan])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListReportPlansResponse Source #

Arguments

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

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

ListReportPlans, listReportPlansResponse_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

$sel:reportPlans:ListReportPlansResponse', listReportPlansResponse_reportPlans - A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

$sel:httpStatus:ListReportPlansResponse', listReportPlansResponse_httpStatus - The response's http status code.

Response Lenses

listReportPlansResponse_nextToken :: Lens' ListReportPlansResponse (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listReportPlansResponse_reportPlans :: Lens' ListReportPlansResponse (Maybe [ReportPlan]) Source #

A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

listReportPlansResponse_httpStatus :: Lens' ListReportPlansResponse Int Source #

The response's http status code.