UpdateAssessmentFrameworkShareCommand

Suggest an Edit

Updates a share request for a custom framework in Audit Manager.

Example Syntax

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

import { AuditManagerClient, UpdateAssessmentFrameworkShareCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import
// const { AuditManagerClient, UpdateAssessmentFrameworkShareCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import
const client = new AuditManagerClient(config);
const input = { // UpdateAssessmentFrameworkShareRequest
  requestId: "STRING_VALUE", // required
  requestType: "SENT" || "RECEIVED", // required
  action: "ACCEPT" || "DECLINE" || "REVOKE", // required
};
const command = new UpdateAssessmentFrameworkShareCommand(input);
const response = await client.send(command);
// { // UpdateAssessmentFrameworkShareResponse
//   assessmentFrameworkShareRequest: { // AssessmentFrameworkShareRequest
//     id: "STRING_VALUE",
//     frameworkId: "STRING_VALUE",
//     frameworkName: "STRING_VALUE",
//     frameworkDescription: "STRING_VALUE",
//     status: "ACTIVE" || "REPLICATING" || "SHARED" || "EXPIRING" || "FAILED" || "EXPIRED" || "DECLINED" || "REVOKED",
//     sourceAccount: "STRING_VALUE",
//     destinationAccount: "STRING_VALUE",
//     destinationRegion: "STRING_VALUE",
//     expirationTime: new Date("TIMESTAMP"),
//     creationTime: new Date("TIMESTAMP"),
//     lastUpdated: new Date("TIMESTAMP"),
//     comment: "STRING_VALUE",
//     standardControlsCount: Number("int"),
//     customControlsCount: Number("int"),
//     complianceType: "STRING_VALUE",
//   },
// };

UpdateAssessmentFrameworkShareCommand Input

See UpdateAssessmentFrameworkShareCommandInput for more details

Parameter
Type
Description
action
Required
ShareRequestAction | undefined

Specifies the update action for the share request.

requestId
Required
string | undefined

The unique identifier for the share request.

requestType
Required
ShareRequestType | undefined

Specifies whether the share request is a sent request or a received request.

UpdateAssessmentFrameworkShareCommand Output

See UpdateAssessmentFrameworkShareCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
assessmentFrameworkShareRequest
AssessmentFrameworkShareRequest | undefined

The updated share request that's returned by the UpdateAssessmentFrameworkShare operation.

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.

ServiceQuotaExceededException
client

You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or request a quota increase  from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for Audit Manager .

ValidationException
client

The request has invalid or missing parameters.

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