CloudWatchOmni / Client / list_omni_dashboards

list_omni_dashboards

CloudWatchOmni.Client.list_omni_dashboards(**kwargs)

Returns the dashboards in a space, optionally filtered by name prefix.

See also: AWS API Documentation

Request Syntax

response = client.list_omni_dashboards(
    spaceId='string',
    namePrefix='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • spaceId (string) –

    [REQUIRED]

    The unique ID of the space.

  • namePrefix (string) – Filter to dashboards whose name starts with this prefix.

  • nextToken (string) – A token to retrieve the next page of results.

  • maxResults (integer) – The maximum number of dashboards to return per page. Defaults to 100. A page can contain fewer results than this value even when more results remain; continue while nextToken is present.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'dashboardId': 'string',
            'arn': 'string',
            'name': 'string',
            'createdBy': 'string',
            'description': 'string',
            'tags': {
                'string': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The list of dashboard summaries.

      • (dict) –

        Summary of a dashboard. Call GetOmniDashboard for the full dashboard.

        • dashboardId (string) –

          The unique ID of the dashboard.

        • arn (string) –

          The Amazon Resource Name (ARN) of the dashboard.

        • name (string) –

          A name that identifies the dashboard.

        • createdBy (string) –

          The principal that created the dashboard.

        • description (string) –

          An optional description of the dashboard.

        • tags (dict) –

          The tags associated with the dashboard.

          • (string) –

            Tag key. Must be non-empty; AWS-standard maximum length. Constraining the key (rather than a bare String) rejects empty-key payloads at the edge with a 400 ValidationException instead of faulting downstream as a 500.

            • (string) –

              Tag value. AWS-standard maximum length; may be empty.

        • createdAt (datetime) –

          The timestamp when the dashboard was created.

        • updatedAt (datetime) –

          The timestamp when the dashboard was last updated.

    • nextToken (string) –

      A token to retrieve the next page of results, or null if there are no more results.

Exceptions