CloudWatchOmni / Client / update_omni_dashboard

update_omni_dashboard

CloudWatchOmni.Client.update_omni_dashboard(**kwargs)

Updates an existing dashboard within a space.

Only the provided fields are changed; omitted fields are left unchanged.

See also: AWS API Documentation

Request Syntax

response = client.update_omni_dashboard(
    spaceId='string',
    dashboardId='string',
    body='string',
    name='string',
    description='string'
)
Parameters:

  • spaceId (string) –

    [REQUIRED]

    The unique ID of the space.

  • dashboardId (string) –

    [REQUIRED]

    The unique ID of the dashboard.

  • body (string) – The new dashboard definition, as a JSON document. Maximum 1 MiB. Omit to leave unchanged.

  • name (string) – A new name for the dashboard. Omit to leave unchanged.

  • description (string) – A new description of the dashboard. Omit to leave unchanged.

Return type:

dict

Returns:

Response Syntax

{
    'omniDashboard': {
        'dashboardId': 'string',
        'arn': 'string',
        'name': 'string',
        'body': 'string',
        'createdBy': 'string',
        'description': 'string',
        'tags': {
            'string': 'string'
        },
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • omniDashboard (dict) –

      The 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.

      • body (string) –

        The dashboard definition.

      • 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.

Exceptions