CreatePolicyCommand

Suggest an Edit

Creates a new managed policy for your Amazon Web Services account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies  in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies  in the IAM User Guide.

For more information about managed policies in general, see Managed policies and inline policies  in the IAM User Guide.

Example Syntax

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

import { IAMClient, CreatePolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, CreatePolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // CreatePolicyRequest
  PolicyName: "STRING_VALUE", // required
  Path: "STRING_VALUE",
  PolicyDocument: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  Tags: [ // tagListType
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new CreatePolicyCommand(input);
const response = await client.send(command);
// { // CreatePolicyResponse
//   Policy: { // Policy
//     PolicyName: "STRING_VALUE",
//     PolicyId: "STRING_VALUE",
//     Arn: "STRING_VALUE",
//     Path: "STRING_VALUE",
//     DefaultVersionId: "STRING_VALUE",
//     AttachmentCount: Number("int"),
//     PermissionsBoundaryUsageCount: Number("int"),
//     IsAttachable: true || false,
//     Description: "STRING_VALUE",
//     CreateDate: new Date("TIMESTAMP"),
//     UpdateDate: new Date("TIMESTAMP"),
//     Tags: [ // tagListType
//       { // Tag
//         Key: "STRING_VALUE", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//   },
// };

CreatePolicyCommand Input

See CreatePolicyCommandInput for more details

Parameter
Type
Description
PolicyDocument
Required
string | undefined

The JSON policy document that you want to use as the content for the new policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas .

To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language  in the IAM User Guide.

The regex pattern  used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF)

  • The special characters tab (u0009), line feed (u000A), and carriage return (u000D)

PolicyName
Required
string | undefined

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Description
string | undefined

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Path
string | undefined

The path for the policy.

For more information about paths, see IAM identifiers  in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (u0021) through the DEL character (u007F), including most punctuation characters, digits, and upper and lowercased letters.

You cannot use an asterisk (*) in the path name.

Tags
Tag[] | undefined

A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources  in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

CreatePolicyCommand Output

See CreatePolicyCommandOutput for details

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

A structure containing details about the new policy.

Throws

Name
Fault
Details
ConcurrentModificationException
client

The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.

EntityAlreadyExistsException
client

The request was rejected because it attempted to create a resource that already exists.

InvalidInputException
client

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

LimitExceededException
client

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

MalformedPolicyDocumentException
client

The request was rejected because the policy document was malformed. The error message describes the specific error.

ServiceFailureException
server

The request processing has failed because of an unknown error, exception or failure.

IAMServiceException
Base exception class for all service exceptions from IAM service.