Skip to content

IAM  >  Operations  >  create_policy

create_policy

Operation

create_policy async

create_policy(input: CreatePolicyInput, plugins: list[Plugin] | None = None) -> CreatePolicyOutput

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.

Parameters:

Name Type Description Default
input CreatePolicyInput

An instance of CreatePolicyInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreatePolicyOutput

An instance of CreatePolicyOutput.

Input

CreatePolicyInput dataclass

Bases: _SerdeShape

Dataclass for CreatePolicyInput structure.

Attributes

description class-attribute instance-attribute
description: str | None = ...

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 class-attribute instance-attribute
path: str | None = ...

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 ! (!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Note

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

policy_document class-attribute instance-attribute
policy_document: str | None = ...
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](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).

To learn more about JSON policy grammar, see [Grammar of the IAM JSON
policy
language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html)
in the *IAM User Guide*.

The [regex pattern](http://wikipedia.org/wiki/regex) used to validate
this parameter is a string of characters consisting of the following:

- Any printable ASCII character ranging from the space character
  (` `) through the end of the ASCII character range

- The printable characters in the Basic Latin and Latin-1 Supplement
  character set (through `ΓΏ`)

- The special characters tab (`     `), line feed (`

), and carriage return ( `)

policy_name class-attribute instance-attribute
policy_name: str | None = ...

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".

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

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.

Note

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.

Output

CreatePolicyOutput dataclass

Bases: _SerdeShape

Contains the response to a successful CreatePolicy request.

Attributes

policy class-attribute instance-attribute
policy: Policy | None = ...

A structure containing details about the new policy.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.