GetAssessmentFrameworkCommand

Suggest an Edit

Gets information about a specified framework.

Example Syntax

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

import { AuditManagerClient, GetAssessmentFrameworkCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import
// const { AuditManagerClient, GetAssessmentFrameworkCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import
const client = new AuditManagerClient(config);
const input = { // GetAssessmentFrameworkRequest
  frameworkId: "STRING_VALUE", // required
};
const command = new GetAssessmentFrameworkCommand(input);
const response = await client.send(command);
// { // GetAssessmentFrameworkResponse
//   framework: { // Framework
//     arn: "STRING_VALUE",
//     id: "STRING_VALUE",
//     name: "STRING_VALUE",
//     type: "Standard" || "Custom",
//     complianceType: "STRING_VALUE",
//     description: "STRING_VALUE",
//     logo: "STRING_VALUE",
//     controlSources: "STRING_VALUE",
//     controlSets: [ // ControlSets
//       { // ControlSet
//         id: "STRING_VALUE",
//         name: "STRING_VALUE",
//         controls: [ // Controls
//           { // Control
//             arn: "STRING_VALUE",
//             id: "STRING_VALUE",
//             type: "Standard" || "Custom" || "Core",
//             name: "STRING_VALUE",
//             description: "STRING_VALUE",
//             testingInformation: "STRING_VALUE",
//             actionPlanTitle: "STRING_VALUE",
//             actionPlanInstructions: "STRING_VALUE",
//             controlSources: "STRING_VALUE",
//             controlMappingSources: [ // ControlMappingSources
//               { // ControlMappingSource
//                 sourceId: "STRING_VALUE",
//                 sourceName: "STRING_VALUE",
//                 sourceDescription: "STRING_VALUE",
//                 sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
//                 sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL" || "Common_Control" || "Core_Control",
//                 sourceKeyword: { // SourceKeyword
//                   keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
//                   keywordValue: "STRING_VALUE",
//                 },
//                 sourceFrequency: "DAILY" || "WEEKLY" || "MONTHLY",
//                 troubleshootingText: "STRING_VALUE",
//               },
//             ],
//             createdAt: new Date("TIMESTAMP"),
//             lastUpdatedAt: new Date("TIMESTAMP"),
//             createdBy: "STRING_VALUE",
//             lastUpdatedBy: "STRING_VALUE",
//             tags: { // TagMap
//               "<keys>": "STRING_VALUE",
//             },
//             state: "ACTIVE" || "END_OF_SUPPORT",
//           },
//         ],
//       },
//     ],
//     createdAt: new Date("TIMESTAMP"),
//     lastUpdatedAt: new Date("TIMESTAMP"),
//     createdBy: "STRING_VALUE",
//     lastUpdatedBy: "STRING_VALUE",
//     tags: {
//       "<keys>": "STRING_VALUE",
//     },
//   },
// };

GetAssessmentFrameworkCommand Input

See GetAssessmentFrameworkCommandInput for more details

Parameter
Type
Description
frameworkId
Required
string | undefined

The identifier for the framework.

GetAssessmentFrameworkCommand Output

See GetAssessmentFrameworkCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
framework
Framework | undefined

The framework that the GetAssessmentFramework API returned.

Throws

Name
Fault
Details
AccessDeniedException
client

Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.

InternalServerException
server

An internal service error occurred during the processing of your request. Try again later.

ResourceNotFoundException
client

The resource that's specified in the request can't be found.

ValidationException
client

The request has invalid or missing parameters.

AuditManagerServiceException
Base exception class for all service exceptions from AuditManager service.