ListGroupsForUserResponse

Contains the response to a successful ListGroupsForUser request.

APIs.ioEngineeringPlatform

Properties

Name Type Description
Groups object
IsTruncated object
Marker object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-listgroupsforuserresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListGroupsForUserResponse",
  "title": "ListGroupsForUserResponse",
  "type": "object",
  "required": [
    "Groups"
  ],
  "example": {
    "Groups": [
      {
        "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test",
        "CreateDate": "2016-11-30 14:10:01.156000+00:00",
        "GroupId": "AGP2111111111EXAMPLE",
        "GroupName": "Test",
        "Path": "/division_abc/subdivision_xyz/product_1234/engineering/"
      },
      {
        "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers",
        "CreateDate": "2016-06-12 20:14:52.032000+00:00",
        "GroupId": "AGPI222222222SEXAMPLE",
        "GroupName": "Managers",
        "Path": "/division_abc/subdivision_xyz/product_1234/"
      }
    ]
  },
  "properties": {
    "Groups": {
      "allOf": [
        {
          "$ref": "#/components/schemas/groupListType"
        },
        {
          "description": "A list of groups."
        }
      ]
    },
    "IsTruncated": {
      "allOf": [
        {
          "$ref": "#/components/schemas/booleanType"
        },
        {
          "description": "A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results."
        }
      ]
    },
    "Marker": {
      "allOf": [
        {
          "$ref": "#/components/schemas/responseMarkerType"
        },
        {
          "description": "When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request."
        }
      ]
    }
  },
  "description": "Contains the response to a successful <a>ListGroupsForUser</a> request. "
}