CloudWatchOmni / Client / create_omni_dashboard

create_omni_dashboard

CloudWatchOmni.Client.create_omni_dashboard(**kwargs)

Creates a new dashboard within a space.

Use GetOmniDashboard and ListOmniDashboards to retrieve dashboards, UpdateOmniDashboard to modify one, and DeleteOmniDashboard to remove it.

See also: AWS API Documentation

Request Syntax

response = client.create_omni_dashboard(
    spaceId='string',
    name='string',
    body='string',
    description='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)
Parameters:

  • spaceId (string) –

    [REQUIRED]

    The unique ID of the space to create the dashboard in.

  • name (string) –

    [REQUIRED]

    A name that identifies the dashboard.

  • body (string) –

    [REQUIRED]

    The dashboard definition, as a JSON document. Maximum 1 MiB.

  • description (string) – An optional description of the dashboard.

  • tags (dict) –

    The tags to associate 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.

  • clientToken (string) –

    Idempotency token for safe retries. Repeated requests with the same token return the original result instead of creating a duplicate.

    This field is autopopulated if not provided.

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