Skip to main content

Policy

Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.

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

Contents

Arn

The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the AWS General Reference.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

AttachmentCount

The number of entities (users, groups, and roles) that the policy is attached to.

Type: Integer

Required: No

CreateDate

The date and time, in ISO 8601 date-time format, when the policy was created.

Type: Timestamp

Required: No

DefaultVersionId

The identifier for the version of the policy that is set as the default version.

Type: String

Pattern: v[1-9][0-9](.[A-Za-z0-9-])?

Required: No

Description

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Type: String

Length Constraints: Maximum length of 1000.

Required: No

Path

The path to the policy.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ((/[A-Za-z0-9.,+@=_-]+)*)/

Required: No

PolicyId

The stable and unique string identifying the policy.

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

Type: String

Length Constraints: Minimum length of 16. Maximum length of 128.

Pattern: [\w]+

Required: No

PolicyName

The friendly name (not ARN) identifying the policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=,.@-]+

Required: No

UpdateDate

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

Type: Timestamp

Required: No