Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

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

Hierarchy

  • Policy

Properties

Arn? AttachmentCount? CreateDate? DefaultVersionId? Description? IsAttachable? Path? PermissionsBoundaryUsageCount? PolicyId? PolicyName? Tags? UpdateDate?

Properties

Optional Arn

Arn?: string

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

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

Optional AttachmentCount

AttachmentCount?: number

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

Optional CreateDate

CreateDate?: Date

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

Optional DefaultVersionId

DefaultVersionId?: string

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

Optional Description

Description?: string

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.

Optional IsAttachable

IsAttachable?: boolean

Specifies whether the policy can be attached to an IAM user, group, or role.

Optional Path

Path?: string

The path to the policy.

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

Optional PermissionsBoundaryUsageCount

PermissionsBoundaryUsageCount?: number

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

Optional PolicyId

PolicyId?: string

The stable and unique string identifying the policy.

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

Optional PolicyName

PolicyName?: string

The friendly name (not ARN) identifying the policy.

Optional Tags

Tags?: Tag[]

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Optional UpdateDate

UpdateDate?: Date

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.

Settings

Member Visibility

Theme