Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Backup.CreateReportPlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Synopsis

data CreateReportPlan = CreateReportPlan' {
- idempotencyToken :: Maybe Text
- reportPlanTags :: Maybe (HashMap Text Text)
- reportPlanDescription :: Maybe Text
- reportPlanName :: Text
- reportDeliveryChannel :: ReportDeliveryChannel
- reportSetting :: ReportSetting
}
newCreateReportPlan :: Text -> ReportDeliveryChannel -> ReportSetting -> CreateReportPlan
createReportPlan_idempotencyToken :: Lens' CreateReportPlan (Maybe Text)
createReportPlan_reportPlanTags :: Lens' CreateReportPlan (Maybe (HashMap Text Text))
createReportPlan_reportPlanDescription :: Lens' CreateReportPlan (Maybe Text)
createReportPlan_reportPlanName :: Lens' CreateReportPlan Text
createReportPlan_reportDeliveryChannel :: Lens' CreateReportPlan ReportDeliveryChannel
createReportPlan_reportSetting :: Lens' CreateReportPlan ReportSetting
data CreateReportPlanResponse = CreateReportPlanResponse' {
- creationTime :: Maybe POSIX
- reportPlanName :: Maybe Text
- reportPlanArn :: Maybe Text
- httpStatus :: Int
}
newCreateReportPlanResponse :: Int -> CreateReportPlanResponse
createReportPlanResponse_creationTime :: Lens' CreateReportPlanResponse (Maybe UTCTime)
createReportPlanResponse_reportPlanName :: Lens' CreateReportPlanResponse (Maybe Text)
createReportPlanResponse_reportPlanArn :: Lens' CreateReportPlanResponse (Maybe Text)
createReportPlanResponse_httpStatus :: Lens' CreateReportPlanResponse Int

Creating a Request

data CreateReportPlan Source #

See: newCreateReportPlan smart constructor.

Constructors

CreateReportPlan'

Fields

idempotencyToken :: Maybe Text
A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
reportPlanTags :: Maybe (HashMap Text Text)
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
reportPlanDescription :: Maybe Text
An optional description of the report plan with a maximum of 1,024 characters.
reportPlanName :: Text
The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
reportDeliveryChannel :: ReportDeliveryChannel
A structure that 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.
reportSetting :: 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

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

newCreateReportPlan Source #

Arguments

:: Text	`$sel:reportPlanName:CreateReportPlan'`
-> ReportDeliveryChannel	`$sel:reportDeliveryChannel:CreateReportPlan'`
-> ReportSetting	`$sel:reportSetting:CreateReportPlan'`
-> CreateReportPlan

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

$sel:reportPlanTags:CreateReportPlan', createReportPlan_reportPlanTags - Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

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

$sel:reportPlanName:CreateReportPlan', createReportPlan_reportPlanName - The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

$sel:reportDeliveryChannel:CreateReportPlan', createReportPlan_reportDeliveryChannel - A structure that 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:reportSetting:CreateReportPlan', createReportPlan_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.

Request Lenses

createReportPlan_idempotencyToken :: Lens' CreateReportPlan (Maybe Text) Source #

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

createReportPlan_reportPlanTags :: Lens' CreateReportPlan (Maybe (HashMap Text Text)) Source #

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

createReportPlan_reportPlanDescription :: Lens' CreateReportPlan (Maybe Text) Source #

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

createReportPlan_reportPlanName :: Lens' CreateReportPlan Text Source #

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

createReportPlan_reportDeliveryChannel :: Lens' CreateReportPlan ReportDeliveryChannel Source #

A structure that 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.

createReportPlan_reportSetting :: Lens' CreateReportPlan 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.

Destructuring the Response

data CreateReportPlanResponse Source #

See: newCreateReportPlanResponse smart constructor.

Constructors

CreateReportPlanResponse'

Fields

creationTime :: Maybe POSIX
The date and time a backup vault 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.
reportPlanName :: Maybe Text
The unique name of the report plan.
reportPlanArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newCreateReportPlanResponse Source #

Arguments

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

Create a value of CreateReportPlanResponse 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:CreateReportPlanResponse', createReportPlanResponse_creationTime - The date and time a backup vault 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:reportPlanName:CreateReportPlan', createReportPlanResponse_reportPlanName - The unique name of the report plan.

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

$sel:httpStatus:CreateReportPlanResponse', createReportPlanResponse_httpStatus - The response's http status code.

Response Lenses

createReportPlanResponse_creationTime :: Lens' CreateReportPlanResponse (Maybe UTCTime) Source #

The date and time a backup vault 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.

createReportPlanResponse_reportPlanName :: Lens' CreateReportPlanResponse (Maybe Text) Source #

The unique name of the report plan.

createReportPlanResponse_reportPlanArn :: Lens' CreateReportPlanResponse (Maybe Text) Source #

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

createReportPlanResponse_httpStatus :: Lens' CreateReportPlanResponse Int Source #

The response's http status code.