ListUsersResponse

Contains the response to a successful ListUsers request.

APIs.ioEngineeringPlatform

Properties

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

JSON Schema

apis-io-engineering-platform-listusersresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListUsersResponse",
  "title": "ListUsersResponse",
  "type": "object",
  "required": [
    "Users"
  ],
  "example": {
    "Users": [
      {
        "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan",
        "CreateDate": "2012-09-05 19:38:48+00:00",
        "PasswordLastUsed": "2016-09-08 21:47:36+00:00",
        "Path": "/division_abc/subdivision_xyz/engineering/",
        "UserId": "AID2MAB8DPLSRHEXAMPLE",
        "UserName": "Juan"
      },
      {
        "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika",
        "CreateDate": "2014-04-09 15:43:45+00:00",
        "PasswordLastUsed": "2016-09-24 16:18:07+00:00",
        "Path": "/division_abc/subdivision_xyz/engineering/",
        "UserId": "AIDIODR4TAW7CSEXAMPLE",
        "UserName": "Anika"
      }
    ]
  },
  "properties": {
    "Users": {
      "allOf": [
        {
          "$ref": "#/components/schemas/userListType"
        },
        {
          "description": "A list of users."
        }
      ]
    },
    "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>ListUsers</a> request. "
}