DeleteOrganizationConformancePackCommand

Suggest an Edit

Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.

Only a management account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.

Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.

Example Syntax

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

import { ConfigServiceClient, DeleteOrganizationConformancePackCommand } from "@aws-sdk/client-config-service"; // ES Modules import
// const { ConfigServiceClient, DeleteOrganizationConformancePackCommand } = require("@aws-sdk/client-config-service"); // CommonJS import
const client = new ConfigServiceClient(config);
const input = { // DeleteOrganizationConformancePackRequest
  OrganizationConformancePackName: "STRING_VALUE", // required
};
const command = new DeleteOrganizationConformancePackCommand(input);
const response = await client.send(command);
// {};

DeleteOrganizationConformancePackCommand Input

See DeleteOrganizationConformancePackCommandInput for more details

Parameter
Type
Description
OrganizationConformancePackName
Required
string | undefined

The name of organization conformance pack that you want to delete.

DeleteOrganizationConformancePackCommand Output

See DeleteOrganizationConformancePackCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
NoSuchOrganizationConformancePackException
client

Config organization conformance pack that you passed in the filter does not exist.

For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.

OrganizationAccessDeniedException
client

For PutConfigurationAggregator API, you can see this exception for the following reasons:

  • No permission to call EnableAWSServiceAccess API

  • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

  • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

  • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principal name before the delegated administrator creates an aggregator.

For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.

ResourceInUseException
client

You see this exception in the following cases:

  • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

  • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

  • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

  • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

  • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

  • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

ConfigServiceServiceException
Base exception class for all service exceptions from ConfigService service.