amazonka-backup-2.0: Amazon Backup SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Backup.Types.ReportPlan

Description

 
Synopsis

Documentation

data ReportPlan Source #

Contains detailed information about a report plan.

See: newReportPlan smart constructor.

Constructors

ReportPlan' 

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.

  • deploymentStatus :: Maybe Text

    The deployment status of a report plan. The statuses are:

    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
  • lastAttemptedExecutionTime :: Maybe POSIX

    The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

  • lastSuccessfulExecutionTime :: Maybe POSIX

    The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

  • reportDeliveryChannel :: Maybe ReportDeliveryChannel

    Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

  • reportPlanArn :: Maybe Text

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

  • reportPlanDescription :: Maybe Text

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

  • reportPlanName :: Maybe 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 (_).

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

Instances

Instances details
FromJSON ReportPlan Source # 
Instance details

Defined in Amazonka.Backup.Types.ReportPlan

Generic ReportPlan Source # 
Instance details

Defined in Amazonka.Backup.Types.ReportPlan

Associated Types

type Rep ReportPlan :: Type -> Type #

Read ReportPlan Source # 
Instance details

Defined in Amazonka.Backup.Types.ReportPlan

Show ReportPlan Source # 
Instance details

Defined in Amazonka.Backup.Types.ReportPlan

NFData ReportPlan Source # 
Instance details

Defined in Amazonka.Backup.Types.ReportPlan

Methods

rnf :: ReportPlan -> () #

Eq ReportPlan Source # 
Instance details

Defined in Amazonka.Backup.Types.ReportPlan

Hashable ReportPlan Source # 
Instance details

Defined in Amazonka.Backup.Types.ReportPlan

type Rep ReportPlan Source # 
Instance details

Defined in Amazonka.Backup.Types.ReportPlan

type Rep ReportPlan = D1 ('MetaData "ReportPlan" "Amazonka.Backup.Types.ReportPlan" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ReportPlan'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "deploymentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastAttemptedExecutionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastSuccessfulExecutionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "reportDeliveryChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReportDeliveryChannel)) :*: S1 ('MetaSel ('Just "reportPlanArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "reportPlanDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reportPlanName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reportSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReportSetting)))))))

newReportPlan :: ReportPlan Source #

Create a value of ReportPlan 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:creationTime:ReportPlan', reportPlan_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.

$sel:deploymentStatus:ReportPlan', reportPlan_deploymentStatus - The deployment status of a report plan. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

$sel:lastAttemptedExecutionTime:ReportPlan', reportPlan_lastAttemptedExecutionTime - The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:lastSuccessfulExecutionTime:ReportPlan', reportPlan_lastSuccessfulExecutionTime - The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:reportDeliveryChannel:ReportPlan', reportPlan_reportDeliveryChannel - Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

$sel:reportPlanArn:ReportPlan', reportPlan_reportPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

$sel:reportPlanDescription:ReportPlan', reportPlan_reportPlanDescription - An optional description of the report plan with a maximum 1,024 characters.

$sel:reportPlanName:ReportPlan', reportPlan_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 (_).

$sel:reportSetting:ReportPlan', reportPlan_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.

reportPlan_creationTime :: Lens' ReportPlan (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.

reportPlan_deploymentStatus :: Lens' ReportPlan (Maybe Text) Source #

The deployment status of a report plan. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

reportPlan_lastAttemptedExecutionTime :: Lens' ReportPlan (Maybe UTCTime) Source #

The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

reportPlan_lastSuccessfulExecutionTime :: Lens' ReportPlan (Maybe UTCTime) Source #

The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

reportPlan_reportDeliveryChannel :: Lens' ReportPlan (Maybe ReportDeliveryChannel) Source #

Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

reportPlan_reportPlanArn :: Lens' ReportPlan (Maybe Text) Source #

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

reportPlan_reportPlanDescription :: Lens' ReportPlan (Maybe Text) Source #

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

reportPlan_reportPlanName :: Lens' ReportPlan (Maybe 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 (_).

reportPlan_reportSetting :: Lens' ReportPlan (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.