2021/10/05 - AWS Backup - 4 updated api methods
Changes AWS Backup Audit Manager framework report.
{'ReportSetting': {'FrameworkArns': ['string'],
'NumberOfFrameworks': 'integer'}}
Response {'CreationTime': 'timestamp'}
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.
See also: AWS API Documentation
Request Syntax
client.create_report_plan(
ReportPlanName='string',
ReportPlanDescription='string',
ReportDeliveryChannel={
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Formats': [
'string',
]
},
ReportSetting={
'ReportTemplate': 'string',
'FrameworkArns': [
'string',
],
'NumberOfFrameworks': 123
},
ReportPlanTags={
'string': 'string'
},
IdempotencyToken='string'
)
string
[REQUIRED]
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 (_).
string
An optional description of the report plan with a maximum of 1,024 characters.
dict
[REQUIRED]
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.
S3BucketName (string) -- [REQUIRED]
The unique name of the S3 bucket that receives your reports.
S3KeyPrefix (string) --
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/ prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
Formats (list) --
A list of the format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .
(string) --
dict
[REQUIRED]
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.
ReportTemplate (string) -- [REQUIRED]
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
FrameworkArns (list) --
The Amazon Resource Names (ARNs) of the frameworks a report covers.
(string) --
NumberOfFrameworks (integer) --
The number of frameworks a report covers.
dict
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
(string) --
(string) --
string
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ReportPlanName': 'string',
'ReportPlanArn': 'string',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ReportPlanName (string) --
The unique name of the report plan.
ReportPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
CreationTime (datetime) --
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.
{'ReportPlan': {'ReportSetting': {'FrameworkArns': ['string'],
'NumberOfFrameworks': 'integer'}}}
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.describe_report_plan(
ReportPlanName='string'
)
string
[REQUIRED]
The unique name of a report plan.
dict
Response Syntax
{
'ReportPlan': {
'ReportPlanArn': 'string',
'ReportPlanName': 'string',
'ReportPlanDescription': 'string',
'ReportSetting': {
'ReportTemplate': 'string',
'FrameworkArns': [
'string',
],
'NumberOfFrameworks': 123
},
'ReportDeliveryChannel': {
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Formats': [
'string',
]
},
'DeploymentStatus': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastAttemptedExecutionTime': datetime(2015, 1, 1),
'LastSuccessfulExecutionTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ReportPlan (dict) --
Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.
ReportPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
ReportPlanName (string) --
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 (_).
ReportPlanDescription (string) --
An optional description of the report plan with a maximum 1,024 characters.
ReportSetting (dict) --
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.
ReportTemplate (string) --
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
FrameworkArns (list) --
The Amazon Resource Names (ARNs) of the frameworks a report covers.
(string) --
NumberOfFrameworks (integer) --
The number of frameworks a report covers.
ReportDeliveryChannel (dict) --
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.
S3BucketName (string) --
The unique name of the S3 bucket that receives your reports.
S3KeyPrefix (string) --
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/ prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
Formats (list) --
A list of the format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .
(string) --
DeploymentStatus (string) --
The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
CreationTime (datetime) --
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.
LastAttemptedExecutionTime (datetime) --
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 (datetime) --
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.
{'ReportPlans': {'ReportSetting': {'FrameworkArns': ['string'],
'NumberOfFrameworks': 'integer'}}}
Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan .
See also: AWS API Documentation
Request Syntax
client.list_report_plans(
MaxResults=123,
NextToken='string'
)
integer
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
string
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.
dict
Response Syntax
{
'ReportPlans': [
{
'ReportPlanArn': 'string',
'ReportPlanName': 'string',
'ReportPlanDescription': 'string',
'ReportSetting': {
'ReportTemplate': 'string',
'FrameworkArns': [
'string',
],
'NumberOfFrameworks': 123
},
'ReportDeliveryChannel': {
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Formats': [
'string',
]
},
'DeploymentStatus': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastAttemptedExecutionTime': datetime(2015, 1, 1),
'LastSuccessfulExecutionTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReportPlans (list) --
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.
(dict) --
Contains detailed information about a report plan.
ReportPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
ReportPlanName (string) --
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 (_).
ReportPlanDescription (string) --
An optional description of the report plan with a maximum 1,024 characters.
ReportSetting (dict) --
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.
ReportTemplate (string) --
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
FrameworkArns (list) --
The Amazon Resource Names (ARNs) of the frameworks a report covers.
(string) --
NumberOfFrameworks (integer) --
The number of frameworks a report covers.
ReportDeliveryChannel (dict) --
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.
S3BucketName (string) --
The unique name of the S3 bucket that receives your reports.
S3KeyPrefix (string) --
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/ prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
Formats (list) --
A list of the format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .
(string) --
DeploymentStatus (string) --
The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
CreationTime (datetime) --
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.
LastAttemptedExecutionTime (datetime) --
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 (datetime) --
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.
NextToken (string) --
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.
{'ReportSetting': {'FrameworkArns': ['string'],
'NumberOfFrameworks': 'integer'}}
Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.
See also: AWS API Documentation
Request Syntax
client.update_report_plan(
ReportPlanName='string',
ReportPlanDescription='string',
ReportDeliveryChannel={
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Formats': [
'string',
]
},
ReportSetting={
'ReportTemplate': 'string',
'FrameworkArns': [
'string',
],
'NumberOfFrameworks': 123
},
IdempotencyToken='string'
)
string
[REQUIRED]
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 (_).
string
An optional description of the report plan with a maximum 1,024 characters.
dict
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.
S3BucketName (string) -- [REQUIRED]
The unique name of the S3 bucket that receives your reports.
S3KeyPrefix (string) --
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/ prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
Formats (list) --
A list of the format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .
(string) --
dict
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.
ReportTemplate (string) -- [REQUIRED]
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
FrameworkArns (list) --
The Amazon Resource Names (ARNs) of the frameworks a report covers.
(string) --
NumberOfFrameworks (integer) --
The number of frameworks a report covers.
string
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ReportPlanName': 'string',
'ReportPlanArn': 'string',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ReportPlanName (string) --
The unique name of the report plan.
ReportPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
CreationTime (datetime) --
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.