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.UpdateReportPlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

Synopsis

data UpdateReportPlan = UpdateReportPlan' {
- idempotencyToken :: Maybe Text
- reportDeliveryChannel :: Maybe ReportDeliveryChannel
- reportPlanDescription :: Maybe Text
- reportSetting :: Maybe ReportSetting
- reportPlanName :: Text
}
newUpdateReportPlan :: Text -> UpdateReportPlan
updateReportPlan_idempotencyToken :: Lens' UpdateReportPlan (Maybe Text)
updateReportPlan_reportDeliveryChannel :: Lens' UpdateReportPlan (Maybe ReportDeliveryChannel)
updateReportPlan_reportPlanDescription :: Lens' UpdateReportPlan (Maybe Text)
updateReportPlan_reportSetting :: Lens' UpdateReportPlan (Maybe ReportSetting)
updateReportPlan_reportPlanName :: Lens' UpdateReportPlan Text
data UpdateReportPlanResponse = UpdateReportPlanResponse' {
- creationTime :: Maybe POSIX
- reportPlanArn :: Maybe Text
- reportPlanName :: Maybe Text
- httpStatus :: Int
}
newUpdateReportPlanResponse :: Int -> UpdateReportPlanResponse
updateReportPlanResponse_creationTime :: Lens' UpdateReportPlanResponse (Maybe UTCTime)
updateReportPlanResponse_reportPlanArn :: Lens' UpdateReportPlanResponse (Maybe Text)
updateReportPlanResponse_reportPlanName :: Lens' UpdateReportPlanResponse (Maybe Text)
updateReportPlanResponse_httpStatus :: Lens' UpdateReportPlanResponse Int

Creating a Request

data UpdateReportPlan Source #

See: newUpdateReportPlan smart constructor.

Constructors

UpdateReportPlan'

Fields

idempotencyToken :: Maybe Text
A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
reportDeliveryChannel :: Maybe ReportDeliveryChannel
A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
reportPlanDescription :: Maybe Text
An optional description of the report plan with a maximum 1,024 characters.
reportSetting :: Maybe ReportSetting
Identifies the report template for the report. Reports are built using a report template. The report templates are:
```
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
```
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
reportPlanName :: Text
The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Instances

Instances details

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

newUpdateReportPlan Source #

Arguments

:: Text	`UpdateReportPlan`
-> UpdateReportPlan

Create a value of UpdateReportPlan 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:idempotencyToken:UpdateReportPlan', updateReportPlan_idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

UpdateReportPlan, updateReportPlan_reportDeliveryChannel - A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

UpdateReportPlan, updateReportPlan_reportPlanDescription - An optional description of the report plan with a maximum 1,024 characters.

UpdateReportPlan, updateReportPlan_reportSetting - Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

UpdateReportPlan, updateReportPlan_reportPlanName - The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Request Lenses

updateReportPlan_idempotencyToken :: Lens' UpdateReportPlan (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

updateReportPlan_reportDeliveryChannel :: Lens' UpdateReportPlan (Maybe ReportDeliveryChannel) Source #

A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

updateReportPlan_reportPlanDescription :: Lens' UpdateReportPlan (Maybe Text) Source #

An optional description of the report plan with a maximum 1,024 characters.

updateReportPlan_reportSetting :: Lens' UpdateReportPlan (Maybe ReportSetting) Source #

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

updateReportPlan_reportPlanName :: Lens' UpdateReportPlan Text Source #

The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Destructuring the Response

data UpdateReportPlanResponse Source #

See: newUpdateReportPlanResponse smart constructor.

Constructors

UpdateReportPlanResponse'

Fields

creationTime :: Maybe POSIX
The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
reportPlanArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
reportPlanName :: Maybe Text
The unique name of the report plan.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newUpdateReportPlanResponse Source #

Arguments

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

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

UpdateReportPlanResponse, updateReportPlanResponse_creationTime - The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

UpdateReportPlanResponse, updateReportPlanResponse_reportPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

UpdateReportPlan, updateReportPlanResponse_reportPlanName - The unique name of the report plan.

$sel:httpStatus:UpdateReportPlanResponse', updateReportPlanResponse_httpStatus - The response's http status code.

Response Lenses

updateReportPlanResponse_creationTime :: Lens' UpdateReportPlanResponse (Maybe UTCTime) Source #

The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

updateReportPlanResponse_reportPlanArn :: Lens' UpdateReportPlanResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

updateReportPlanResponse_reportPlanName :: Lens' UpdateReportPlanResponse (Maybe Text) Source #

The unique name of the report plan.

updateReportPlanResponse_httpStatus :: Lens' UpdateReportPlanResponse Int Source #

The response's http status code.