Class GetContextKeysForCustomPolicyCommandProtected

Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request.

Example

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

import { IAMClient, GetContextKeysForCustomPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, GetContextKeysForCustomPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // GetContextKeysForCustomPolicyRequest
  PolicyInputList: [ // SimulationPolicyListType // required
    "STRING_VALUE",
  ],
};
const command = new GetContextKeysForCustomPolicyCommand(input);
const response = await client.send(command);
// { // GetContextKeysForPolicyResponse
//   ContextKeyNames: [ // ContextKeyNamesResultListType
//     "STRING_VALUE",
//   ],
// };

Param

GetContextKeysForCustomPolicyCommandInput

Returns

GetContextKeysForCustomPolicyCommandOutput

See

• GetContextKeysForCustomPolicyCommandInput for command's input shape.
• GetContextKeysForCustomPolicyCommandOutput for command's response shape.
• config for IAMClient's config shape.

Throws

InvalidInputException (client fault)

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.