Amazon CodeCatalyst · JSON Structure

Amazon Codecatalyst List Event Logs Request Structure

ListEventLogsRequest schema from Amazon CodeCatalyst

Type: object Properties: 5 Required: 2
AmazonDeveloper ToolsCI/CDCollaborationDevOpsSource Control

ListEventLogsRequest is a JSON Structure definition published by Amazon CodeCatalyst, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

startTime endTime eventName nextToken maxResults

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codecatalyst/refs/heads/main/json-structure/amazon-codecatalyst-list-event-logs-request-structure.json",
  "name": "ListEventLogsRequest",
  "description": "ListEventLogsRequest schema from Amazon CodeCatalyst",
  "type": "object",
  "properties": {
    "startTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SyntheticTimestamp_date_time"
        },
        {
          "description": "The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in <a href=\"https://www.rfc-editor.org/rfc/rfc3339#section-5.6\">RFC 3339</a>."
        }
      ]
    },
    "endTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SyntheticTimestamp_date_time"
        },
        {
          "description": "The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in <a href=\"https://www.rfc-editor.org/rfc/rfc3339#section-5.6\">RFC 3339</a>."
        }
      ]
    },
    "eventName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the event."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListEventLogsRequestNextTokenString"
        },
        {
          "description": "A token returned from a call to this API to indicate the next batch of results to return, if any."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListEventLogsRequestMaxResultsInteger"
        },
        {
          "description": "The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results."
        }
      ]
    }
  },
  "required": [
    "startTime",
    "endTime"
  ]
}