---
title: "GET /audit/frameworks/{frameworkName}"
method: GET
path: "/audit/frameworks/{frameworkName}"
---

# GET /audit/frameworks/{frameworkName}

`GET /audit/frameworks/{frameworkName}`

Returns the framework details for the specified <code>FrameworkName</code>.

## Path parameters

- `frameworkName` string, required

## Response `200`

Success

- DescribeFrameworkOutput
  - `FrameworkName` string — The unique name of a framework.
  - `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.
  - `FrameworkControls` FrameworkControl[] — A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
    - `ControlName` string, required — The name of a control. This name is between 1 and 256 characters.
    - `ControlInputParameters` ControlInputParameter[] — A list of <code>ParameterName</code> and <code>ParameterValue</code> pairs.
      - `ParameterName` string — The name of a parameter, for example, <code>BackupPlanFrequency</code>.
      - `ParameterValue` string — The value of parameter, for example, <code>hourly</code>.
    - `ControlScope` object — 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. For more information, see <a href="aws-backup/latest/devguide/API_ControlScope.html"> <code>ControlScope</code>.</a>
      - `ComplianceResourceIds` String[] — The ID of the only Amazon Web Services resource that you want your control scope to contain.
      - `ComplianceResourceTypes` ARN[] — Describes whether the control scope includes one or more types of resources, such as <code>EFS</code> or <code>RDS</code>.
      - `Tags` object — 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: <code>[{"Key":"string","Value":"string"}]</code>.
  - `CreationTime` string, date-time — The date and time that a framework is created, in ISO 8601 representation. The value of <code>CreationTime</code> 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 — <p>The deployment status of a framework. The statuses are:</p> <p> <code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED</code> </p>
  - `FrameworkStatus` string — <p>A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:</p> <ul> <li> <p> <code>ACTIVE</code> when recording is turned on for all resources governed by the framework.</p> </li> <li> <p> <code>PARTIALLY_ACTIVE</code> when recording is turned off for at least one resource governed by the framework.</p> </li> <li> <p> <code>INACTIVE</code> when recording is turned off for all resources governed by the framework.</p> </li> <li> <p> <code>UNAVAILABLE</code> when Backup is unable to validate recording status at this time.</p> </li> </ul>
  - `IdempotencyToken` string — A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>DescribeFrameworkOutput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.

## Other responses

- `480` — ResourceNotFoundException
- `481` — InvalidParameterValueException
- `482` — MissingParameterValueException
- `483` — ServiceUnavailableException

---

[API](https://skmtc.net/aws/apis/backup.md) · [All operations](https://skmtc.net/aws/apis/backup/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/backup/versions/386d8a5f8871/schema)