Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeFramework

Returns the framework details for the specified FrameworkName.

Request Syntax


GET /audit/frameworks/frameworkName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

frameworkName

The unique name of a framework.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z][_a-zA-Z0-9]*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "DeploymentStatus": "string",
   "FrameworkArn": "string",
   "FrameworkControls": [ 
      { 
         "ControlInputParameters": [ 
            { 
               "ParameterName": "string",
               "ParameterValue": "string"
            }
         ],
         "ControlName": "string",
         "ControlScope": { 
            "ComplianceResourceIds": [ "string" ],
            "ComplianceResourceTypes": [ "string" ],
            "Tags": { 
               "string" : "string" 
            }
         }
      }
   ],
   "FrameworkDescription": "string",
   "FrameworkName": "string",
   "FrameworkStatus": "string",
   "IdempotencyToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreationTime

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.

Type: Timestamp

DeploymentStatus

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Type: String

FrameworkArn

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

Type: String

FrameworkControls

The controls that make up the framework. Each control in the list has a name, input parameters, and scope.

Type: Array of FrameworkControl objects

FrameworkDescription

An optional description of the framework.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*\S.*

FrameworkName

The unique name of a framework.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z][_a-zA-Z0-9]*

FrameworkStatus

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 AWS Config recording on or off for each resource. The statuses are:

ACTIVE when recording is turned on for all resources governed by the framework.
PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
INACTIVE when recording is turned off for all resources governed by the framework.
UNAVAILABLE when AWS Backup is unable to validate recording status at this time.

Type: String

IdempotencyToken

A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500