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.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
PolicyName	object
PolicyId	object
Arn	object
Path	object
DefaultVersionId	object
AttachmentCount	object
PermissionsBoundaryUsageCount	object
IsAttachable	object
Description	object
CreateDate	object
UpdateDate	object
Tags	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Policy",
  "title": "Policy",
  "type": "object",
  "properties": {
    "PolicyName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/policyNameType"
        },
        {
          "description": "The friendly name (not ARN) identifying the policy."
        }
      ]
    },
    "PolicyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/idType"
        },
        {
          "description": "<p>The stable and unique string identifying the policy.</p> <p>For more information about IDs, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM identifiers</a> in the <i>IAM User Guide</i>.</p>"
        }
      ]
    },
    "Arn": {
      "$ref": "#/components/schemas/arnType"
    },
    "Path": {
      "allOf": [
        {
          "$ref": "#/components/schemas/policyPathType"
        },
        {
          "description": "<p>The path to the policy.</p> <p>For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM identifiers</a> in the <i>IAM User Guide</i>.</p>"
        }
      ]
    },
    "DefaultVersionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/policyVersionIdType"
        },
        {
          "description": "The identifier for the version of the policy that is set as the default version."
        }
      ]
    },
    "AttachmentCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/attachmentCountType"
        },
        {
          "description": "The number of entities (users, groups, and roles) that the policy is attached to."
        }
      ]
    },
    "PermissionsBoundaryUsageCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/attachmentCountType"
        },
        {
          "description": "<p>The number of entities (users and roles) for which the policy is used to set the permissions boundary. </p> <p>For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions boundaries for IAM identities </a> in the <i>IAM User Guide</i>.</p>"
        }
      ]
    },
    "IsAttachable": {
      "allOf": [
        {
          "$ref": "#/components/schemas/booleanType"
        },
        {
          "description": "Specifies whether the policy can be attached to an IAM user, group, or role."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/policyDescriptionType"
        },
        {
          "description": "<p>A friendly description of the policy.</p> <p>This element is included in the response to the <a>GetPolicy</a> operation. It is not included in the response to the <a>ListPolicies</a> operation. </p>"
        }
      ]
    },
    "CreateDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/dateType"
        },
        {
          "description": "The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the policy was created."
        }
      ]
    },
    "UpdateDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/dateType"
        },
        {
          "description": "<p>The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the policy was last updated.</p> <p>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.</p>"
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/tagListType"
        },
        {
          "description": "A list of tags that are attached to the instance profile. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html\">Tagging IAM resources</a> in the <i>IAM User Guide</i>."
        }
      ]
    }
  },
  "description": "<p>Contains information about a managed policy.</p> <p>This data type is used as a response element in the <a>CreatePolicy</a>, <a>GetPolicy</a>, and <a>ListPolicies</a> operations. </p> <p>For more information about managed policies, refer to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed policies and inline policies</a> in the <i>IAM User Guide</i>. </p>"
}