CustomerProfiles / Client / get_domain_layout

get_domain_layout

CustomerProfiles.Client.get_domain_layout(**kwargs)

Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_layout(
    DomainName='string',
    LayoutDefinitionName='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • LayoutDefinitionName (string) –

    [REQUIRED]

    The unique name of the layout.

Return type:

dict

Returns:

Response Syntax

{
    'LayoutDefinitionName': 'string',
    'Description': 'string',
    'DisplayName': 'string',
    'IsDefault': True|False,
    'LayoutType': 'PROFILE_EXPLORER',
    'Layout': 'string',
    'Version': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • LayoutDefinitionName (string) –

      The unique name of the layout.

    • Description (string) –

      The description of the layout

    • DisplayName (string) –

      The display name of the layout

    • IsDefault (boolean) –

      If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

    • LayoutType (string) –

      The type of layout that can be used to view data under a Customer Profiles domain.

    • Layout (string) –

      A customizable layout that can be used to view data under a Customer Profiles domain.

    • Version (string) –

      The version used to create layout.

    • CreatedAt (datetime) –

      The timestamp of when the layout was created.

    • LastUpdatedAt (datetime) –

      The timestamp of when the layout was most recently updated.

    • Tags (dict) –

      The tags used to organize, track, or control access for this resource.

      • (string) –

        • (string) –

Exceptions