DescribeFrameworkCommand

Suggest an Edit

Returns the framework details for the specified FrameworkName.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { BackupClient, DescribeFrameworkCommand } from "@aws-sdk/client-backup"; // ES Modules import
// const { BackupClient, DescribeFrameworkCommand } = require("@aws-sdk/client-backup"); // CommonJS import
const client = new BackupClient(config);
const input = { // DescribeFrameworkInput
  FrameworkName: "STRING_VALUE", // required
};
const command = new DescribeFrameworkCommand(input);
const response = await client.send(command);
// { // DescribeFrameworkOutput
//   FrameworkName: "STRING_VALUE",
//   FrameworkArn: "STRING_VALUE",
//   FrameworkDescription: "STRING_VALUE",
//   FrameworkControls: [ // FrameworkControls
//     { // FrameworkControl
//       ControlName: "STRING_VALUE", // required
//       ControlInputParameters: [ // ControlInputParameters
//         { // ControlInputParameter
//           ParameterName: "STRING_VALUE",
//           ParameterValue: "STRING_VALUE",
//         },
//       ],
//       ControlScope: { // ControlScope
//         ComplianceResourceIds: [ // ComplianceResourceIdList
//           "STRING_VALUE",
//         ],
//         ComplianceResourceTypes: [ // ResourceTypeList
//           "STRING_VALUE",
//         ],
//         Tags: { // stringMap
//           "<keys>": "STRING_VALUE",
//         },
//       },
//     },
//   ],
//   CreationTime: new Date("TIMESTAMP"),
//   DeploymentStatus: "STRING_VALUE",
//   FrameworkStatus: "STRING_VALUE",
//   IdempotencyToken: "STRING_VALUE",
// };

DescribeFrameworkCommand Input

See DescribeFrameworkCommandInput for more details

Parameter
Type
Description
FrameworkName
Required
string | undefined

The unique name of a framework.

DescribeFrameworkCommand Output

See DescribeFrameworkCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreationTime
Date | undefined

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 | undefined

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

FrameworkArn
string | undefined

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

FrameworkControls
FrameworkControl[] | undefined

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

FrameworkDescription
string | undefined

An optional description of the framework.

FrameworkName
string | undefined

The unique name of a framework.

FrameworkStatus
string | undefined

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:

  • 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 Backup is unable to validate recording status at this time.

IdempotencyToken
string | undefined

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.

Throws

Name
Fault
Details
InvalidParameterValueException
client

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

MissingParameterValueException
client

Indicates that a required parameter is missing.

ResourceNotFoundException
client

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

ServiceUnavailableException
server

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

BackupServiceException
Base exception class for all service exceptions from Backup service.