Amazon CloudTrail Cloudtrail Dashboard API

openapi: 3.2.0
info:
  title: AWS CloudTrail Dashboard API
  version: '2013-11-01'
  description: Generated from AWS's published Smithy model for AWS CloudTrail. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://cloudtrail.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Dashboard
paths:
  /#CreateDashboard:
    post:
      operationId: CreateDashboard
      summary: Create Dashboard
      description: CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Creates a custom dashboard or the Highlights dashboard. Custom dashboards - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule. Highlights dashboard - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule. CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more inform
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDashboardResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: EventDataStoreNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EventDataStoreNotFoundException'
        '400':
          description: InactiveEventDataStoreException; InsufficientEncryptionPolicyException; InvalidQueryStatementException; InvalidTagParameterException; ServiceQuotaExceededException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InactiveEventDataStoreException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.CreateDashboard
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDashboardRequest'
      tags:
      - Dashboard
  /#DeleteDashboard:
    post:
      operationId: DeleteDashboard
      summary: Delete Dashboard
      description: CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Deletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteDashboardResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '400':
          description: ResourceNotFoundException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.DeleteDashboard
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDashboardRequest'
      tags:
      - Dashboard
  /#GetDashboard:
    post:
      operationId: GetDashboard
      summary: Get Dashboard
      description: CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Returns the specified dashboard.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDashboardResponse'
        '400':
          description: ResourceNotFoundException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.GetDashboard
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDashboardRequest'
      tags:
      - Dashboard
  /#ListDashboards:
    post:
      operationId: ListDashboards
      summary: List Dashboards
      description: CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Returns information about all dashboards in the account, in the current Region.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDashboardsResponse'
        '400':
          description: UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UnsupportedOperationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.ListDashboards
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDashboardsRequest'
      tags:
      - Dashboard
  /#UpdateDashboard:
    post:
      operationId: UpdateDashboard
      summary: Update Dashboard
      description: 'CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Updates the specified dashboard. To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide. CloudTrail runs queries to populate the dashboard''s widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateDashboardResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: EventDataStoreNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EventDataStoreNotFoundException'
        '400':
          description: InactiveEventDataStoreException; InsufficientEncryptionPolicyException; InvalidQueryStatementException; ResourceNotFoundException; ServiceQuotaExceededException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InactiveEventDataStoreException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.UpdateDashboard
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateDashboardRequest'
      tags:
      - Dashboard
components:
  schemas:
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.
        Value:
          type: string
          description: The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
      required:
      - Key
    DeleteDashboardRequest:
      type: object
      properties:
        DashboardId:
          type: string
          description: The name or ARN for the dashboard.
      required:
      - DashboardId
    RefreshScheduleFrequency:
      type: object
      properties:
        Unit:
          type: string
          enum:
          - HOURS
          - DAYS
          description: The unit to use for the refresh. For custom dashboards, the unit can be HOURS or DAYS. For the Highlights dashboard, the Unit must be HOURS.
        Value:
          type: integer
          description: 'The value for the refresh schedule. For custom dashboards, the following values are valid when the unit is HOURS: 1, 6, 12, 24 For custom dashboards, the only valid value when the unit is DAYS is 1. For the Highlights dashboard, the Value must be 6.'
    DeleteDashboardResponse:
      type: object
      properties: {}
    Widget:
      type: object
      properties:
        QueryAlias:
          type: string
          description: The query alias used to identify the query for the widget.
        QueryStatement:
          type: string
          description: The SQL query statement for the widget.
        QueryParameters:
          type: array
          items:
            type: string
          description: The query parameters for the widget.
        ViewProperties:
          type: object
          additionalProperties:
            type: string
          description: The view properties for the widget. For more information about view properties, see View properties for widgets in the CloudTrail User Guide..
    CreateDashboardResponse:
      type: object
      properties:
        DashboardArn:
          type: string
          description: The ARN for the dashboard.
        Name:
          type: string
          description: The name of the dashboard.
        Type:
          type: string
          enum:
          - MANAGED
          - CUSTOM
          description: The dashboard type.
        Widgets:
          type: array
          items:
            $ref: '#/components/schemas/Widget'
          description: An array of widgets for the dashboard.
        TagsList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        RefreshSchedule:
          $ref: '#/components/schemas/RefreshSchedule'
        TerminationProtectionEnabled:
          type: boolean
          description: Indicates whether termination protection is enabled for the dashboard.
    InactiveEventDataStoreException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
    RequestWidget:
      type: object
      properties:
        QueryStatement:
          type: string
          description: 'The query statement for the widget. For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account. When a query uses ? with eventTime, ? must be surrounded by single quotes as follows: ''?''.'
        QueryParameters:
          type: array
          items:
            type: string
          description: 'The optional query parameters. The following query parameters are valid: $StartTime$, $EndTime$, and $Period$.'
        ViewProperties:
          type: object
          additionalProperties:
            type: string
          description: The view properties for the widget. For more information about view properties, see View properties for widgets in the CloudTrail User Guide.
      required:
      - QueryStatement
      - ViewProperties
    ConflictException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
    UpdateDashboardResponse:
      type: object
      properties:
        DashboardArn:
          type: string
          description: The ARN for the dashboard.
        Name:
          type: string
          description: The name for the dashboard.
        Type:
          type: string
          enum:
          - MANAGED
          - CUSTOM
          description: The type of dashboard.
        Widgets:
          type: array
          items:
            $ref: '#/components/schemas/Widget'
          description: An array of widgets for the dashboard.
        RefreshSchedule:
          $ref: '#/components/schemas/RefreshSchedule'
        TerminationProtectionEnabled:
          type: boolean
          description: Indicates whether termination protection is enabled for the dashboard.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The timestamp that shows when the dashboard was created.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The timestamp that shows when the dashboard was updated.
    UpdateDashboardRequest:
      type: object
      properties:
        DashboardId:
          type: string
          description: The name or ARN of the dashboard.
        Widgets:
          type: array
          items:
            $ref: '#/components/schemas/RequestWidget'
          description: An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets. To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard. To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.
        RefreshSchedule:
          $ref: '#/components/schemas/RefreshSchedule'
        TerminationProtectionEnabled:
          type: boolean
          description: Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.
      required:
      - DashboardId
    RefreshSchedule:
      type: object
      properties:
        Frequency:
          $ref: '#/components/schemas/RefreshScheduleFrequency'
        Status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.
        TimeOfDay:
          type: string
          description: The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.
    CreateDashboardRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the dashboard. The name must be unique to your account. To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.
        RefreshSchedule:
          $ref: '#/components/schemas/RefreshSchedule'
        TagsList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        TerminationProtectionEnabled:
          type: boolean
          description: Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.
        Widgets:
          type: array
          items:
            $ref: '#/components/schemas/RequestWidget'
          description: An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets. You do not need to specify widgets for the Highlights dashboard.
      required:
      - Name
    EventDataStoreNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
    ListDashboardsRequest:
      type: object
      properties:
        NamePrefix:
          type: string
          description: Specify a name prefix to filter on.
        Type:
          type: string
          enum:
          - MANAGED
          - CUSTOM
          description: 'Specify a dashboard type to filter on: CUSTOM or MANAGED.'
        NextToken:
          type: string
          description: A token you can use to get the next page of dashboard results.
        MaxResults:
          type: integer
          description: The maximum number of dashboards to display on a single page.
    UnsupportedOperationException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
    DashboardDetail:
      type: object
      properties:
        DashboardArn:
          type: string
          description: The ARN for the dashboard.
        Type:
          type: string
          enum:
          - MANAGED
          - CUSTOM
          description: The type of dashboard.
    GetDashboardRequest:
      type: object
      properties:
        DashboardId:
          type: string
          description: The name or ARN for the dashboard.
      required:
      - DashboardId
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
    GetDashboardResponse:
      type: object
      properties:
        DashboardArn:
          type: string
          description: The ARN for the dashboard.
        Type:
          type: string
          enum:
          - MANAGED
          - CUSTOM
          description: The type of dashboard.
        Status:
          type: string
          enum:
          - CREATING
          - CREATED
          - UPDATING
          - UPDATED
          - DELETING
          description: The status of the dashboard.
        Widgets:
          type: array
          items:
            $ref: '#/components/schemas/Widget'
          description: An array of widgets for the dashboard.
        RefreshSchedule:
          $ref: '#/components/schemas/RefreshSchedule'
        CreatedTimestamp:
          type: string
          format: date-time
          description: The timestamp that shows when the dashboard was created.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The timestamp that shows when the dashboard was last updated.
        LastRefreshId:
          type: string
          description: The ID of the last dashboard refresh.
        LastRefreshFailureReason:
          type: string
          description: Provides information about failures for the last scheduled refresh.
        TerminationProtectionEnabled:
          type: boolean
          description: Indicates whether termination protection is enabled for the dashboard.
    ListDashboardsResponse:
      type: object
      properties:
        Dashboards:
          type: array
          items:
            $ref: '#/components/schemas/DashboardDetail'
          description: Contains information about dashboards in the account, in the current Region that match the applied filters.
        NextToken:
          type: string
          description: A token you can use to get the next page of dashboard results.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: cloudtrail
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudtrail/service/2013-11-01/cloudtrail-2013-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)