Backup / Client / update_framework
update_framework#
- Backup.Client.update_framework(**kwargs)#
Updates an existing framework identified by its
FrameworkName
with the input document in JSON format.See also: AWS API Documentation
Request Syntax
response = client.update_framework( FrameworkName='string', FrameworkDescription='string', FrameworkControls=[ { 'ControlName': 'string', 'ControlInputParameters': [ { 'ParameterName': 'string', 'ParameterValue': 'string' }, ], 'ControlScope': { 'ComplianceResourceIds': [ 'string', ], 'ComplianceResourceTypes': [ 'string', ], 'Tags': { 'string': 'string' } } }, ], IdempotencyToken='string' )
- Parameters:
FrameworkName (string) –
[REQUIRED]
The unique name of a framework. 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 (_).
FrameworkDescription (string) – An optional description of the framework with a maximum 1,024 characters.
FrameworkControls (list) –
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
(dict) –
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
ControlName (string) – [REQUIRED]
The name of a control. This name is between 1 and 256 characters.
ControlInputParameters (list) –
A list of
ParameterName
andParameterValue
pairs.(dict) –
A list of parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: “backup plan frequency is at least
daily
and the retention period is at least1 year
”. The first parameter isdaily
. The second parameter is1 year
.ParameterName (string) –
The name of a parameter, for example,
BackupPlanFrequency
.ParameterValue (string) –
The value of parameter, for example,
hourly
.
ControlScope (dict) –
The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.
ComplianceResourceIds (list) –
The ID of the only Amazon Web Services resource that you want your control scope to contain.
(string) –
ComplianceResourceTypes (list) –
Describes whether the control scope includes one or more types of resources, such as
EFS
orRDS
.(string) –
Tags (dict) –
The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is:
[{"Key":"string","Value":"string"}]
.(string) –
(string) –
IdempotencyToken (string) –
A customer-chosen string that you can use to distinguish between otherwise identical calls to
UpdateFrameworkInput
. 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.
- Return type:
dict
- Returns:
Response Syntax
{ 'FrameworkName': 'string', 'FrameworkArn': 'string', 'CreationTime': datetime(2015, 1, 1) }
Response Structure
(dict) –
FrameworkName (string) –
The unique name of a framework. 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 (_).
FrameworkArn (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 framework is created, in ISO 8601 representation. The value of
CreationTime
is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
Exceptions
Backup.Client.exceptions.AlreadyExistsException
Backup.Client.exceptions.ResourceNotFoundException
Backup.Client.exceptions.LimitExceededException
Backup.Client.exceptions.InvalidParameterValueException
Backup.Client.exceptions.MissingParameterValueException
Backup.Client.exceptions.ConflictException
Backup.Client.exceptions.ServiceUnavailableException