Group

Contains information about an IAM group entity.

This data type is used as a response element in the following operations:

APIs.ioEngineeringPlatform

Properties

Name Type Description
Path object
GroupName object
GroupId object
Arn object
CreateDate object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-group-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Group",
  "title": "Group",
  "type": "object",
  "required": [
    "Path",
    "GroupName",
    "GroupId",
    "Arn",
    "CreateDate"
  ],
  "properties": {
    "Path": {
      "allOf": [
        {
          "$ref": "#/components/schemas/pathType"
        },
        {
          "description": "The path to the group. 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>. "
        }
      ]
    },
    "GroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/groupNameType"
        },
        {
          "description": "The friendly name that identifies the group."
        }
      ]
    },
    "GroupId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/idType"
        },
        {
          "description": " The stable and unique string identifying the group. 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>. "
        }
      ]
    },
    "Arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/arnType"
        },
        {
          "description": " The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM identifiers</a> in the <i>IAM User Guide</i>. "
        }
      ]
    },
    "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 group was created."
        }
      ]
    }
  },
  "description": "<p>Contains information about an IAM group entity.</p> <p>This data type is used as a response element in the following operations:</p> <ul> <li> <p> <a>CreateGroup</a> </p> </li> <li> <p> <a>GetGroup</a> </p> </li> <li> <p> <a>ListGroups</a> </p> </li> </ul>"
}