Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472262334.5 KB

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

get/audit/frameworks/{frameworkName}

Path parameters

frameworkNamestring required

The unique name of a framework.

Response

Success

FrameworkNamestring

The unique name of a framework.

FrameworkArnstring

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

FrameworkDescriptionstring

An optional description of the framework.

CreationTimestring 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.

DeploymentStatusstring
<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>
FrameworkStatusstring
<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>
IdempotencyTokenstring

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.