Backup / Client / list_frameworks
list_frameworks#
- Backup.Client.list_frameworks(**kwargs)#
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.list_frameworks( MaxResults=123, NextToken='string' )
- Parameters:
MaxResults (integer) – The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
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.
- Return type:
dict
- Returns:
Response Syntax
{ 'Frameworks': [ { 'FrameworkName': 'string', 'FrameworkArn': 'string', 'FrameworkDescription': 'string', 'NumberOfControls': 123, 'CreationTime': datetime(2015, 1, 1), 'DeploymentStatus': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
Frameworks (list) –
A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.
(dict) –
Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
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.
FrameworkDescription (string) –
An optional description of the framework with a maximum 1,024 characters.
NumberOfControls (integer) –
The number of controls contained by the framework.
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.DeploymentStatus (string) –
The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
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.
Exceptions
Backup.Client.exceptions.InvalidParameterValueException
Backup.Client.exceptions.ServiceUnavailableException